python-eel/Eel

PyInstaller with Electron

Open

#712 opened on Dec 6, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,980 stars) (570 forks)batch import
help wanted

Description

Describe the problem I have a problem while trying to run the result from Pyinstaller with eel and electron.

Code snippet(s)

python3 -m eel backend/main.py design --onefile  
python3 -m eel backend/main.py design --onefile --noconsole

Same issue while I am trying to run the result package with and without --noconsole

Terminal's result when opening the package:

Traceback (most recent call last):
  File "main.py", line 45, in <module>
  File "eel/__init__.py", line 174, in start
  File "eel/__init__.py", line 206, in show
  File "eel/browsers.py", line 77, in open
OSError: Can't find Electron installation
[31748] Failed to execute script 'main' due to unhandled exception!

Desktop:

  • OS: macOS Sonoma 14.1.2
  • Browser (using electron)

Contributor guide

Tech stack
pythonelectron
Domain
desktop
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonEelPyInstallerElectron
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the `open` function in `eel/browsers.py` (line 77) which raises the OSError. The issue likely occurs because PyInstaller does not bundle the Electron binary. Research how Eel locates Electron and how to properly include Electron in a PyInstaller one file build. Consider adding a PyInstaller hook or documentation to guide users on bundling Electron.