https://github.com/jabbalaci/PythonEXE
How to create an executable file from a Python script?
https://github.com/jabbalaci/PythonEXE
exe pipenv pyinstaller python python3 virtual-environment
Last synced: about 2 months ago
JSON representation
How to create an executable file from a Python script?
- Host: GitHub
- URL: https://github.com/jabbalaci/PythonEXE
- Owner: jabbalaci
- License: mit
- Created: 2019-02-09T21:55:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-18T14:40:47.000Z (3 months ago)
- Last Synced: 2025-04-19T04:11:18.573Z (3 months ago)
- Topics: exe, pipenv, pyinstaller, python, python3, virtual-environment
- Language: Python
- Size: 337 KB
- Stars: 282
- Watchers: 19
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Python EXE Maker
================
This little project shows you how to build an executable file
of your Python code.
Here, `hello.py` is the main file. It uses a module (`helper.py`),
it imports the `os` module from the stdlib, and it even uses
a 3rd-party library (`requests`).
With PyInstaller, you can easily create a single executable file from
this project.
$ pyinstaller --onefile hello.py
Under Windows you might have a problem with this. If the `.exe` complains that
a DLL is missing, then try this variation:
$ pyinstaller --onefile --noupx hello.py
You'll find the exe in the `dist/` folder.
Why would you need an EXE?
--------------------------
EXE is a file extension for an executable file format. It makes distributing your
program much easier. The exe produced by PyInstaller is standalone.
It means that it's enough to give this exe to your friend and (s)he can run it right away.
There is no need to install Python on his/her machine, no need to create a virtual environment, etc.
Under Windows you can simply start an exe with a double click.
Of course, if your friend uses Windows (Linux), then create the exe under
Windows (Linux).
Will my EXE run faster?
-----------------------
**No.** PyInstaller simply creates a bundle that contains everything: your code,
the necessary modules / packages, the virtual environment, the Python interpreter, etc.
When you launch the EXE, it is extracted to your temp folder (under Linux
it's the `/tmp` folder), and your application is started from there. So the
runtime will be approximately the same.
For a demo, check out my simple Fibonacci implementation in the folder `speed_test`.
Making an EXE
-------------
The project uses the [uv](https://docs.astral.sh/uv/) package manager. Download
the project and enter its folder. Then, issue the command
$ uv sync
With this ^ command you can create the virtual environment
and install the necessary packages in the virt. env.
Then, try to execute the program:
$ make run
If it works, create an executable of it
by using one of the following commands:
$ make exe
or
$ make exe2
The EXE will be stored in the `dist/` folder.
Video
-----
Click on the image below to open a YouTube video that shows you everything step-by-step:
Changes since the video was made:
* The project was updated to Python 3.13.
* In the video I talk about pipenv, but the project was updated to use uv.
Links / News / Related Work
---------------------------
* This project of mine got included in [PyCoder's Weekly -- Issue #355](https://pycoders.com/issues/355)
under the title "PythonEXE: How to Create an Executable File From a Python Script?"
* Reddit discussion: [here](https://old.reddit.com/r/learnpython/comments/aoxoki/i_made_a_sample_project_to_demonstrate_how_to/).
* [Using PyInstaller to Easily Distribute Python Applications](https://realpython.com/pyinstaller-python/),
a blog post on the same topic
* [PyUpdater](https://github.com/JMSwag/PyUpdater), a pyinstaller auto-update framework