auto-py-to-exe

English | 简体中文 | Suomen kieli | Türkçe | فارسی | 한국어 | Български | हिन्दी | עברית | Беларуская | Slovenščina | српски | srpski | Русский | Français

Demo

Getting Started

Prerequisites

• Python: 3.6-3.14

To have the interface displayed in the images, you will need Chrome. If Chrome is not installed or --default-browser is passed, the default browser will be used.

Installation and Usage

Installing via PyPI

You can install this project using PyPI:

pip install auto-py-to-exe

Then to run it, execute the following in the terminal:

auto-py-to-exe

If you have more than one version of Python installed, you can use python -m auto_py_to_exe instead of auto-py-to-exe.

Installing via GitHub

git clone https://github.com/brentvollebregt/auto-py-to-exe.git
cd auto-py-to-exe
python setup.py install

Then to run it, execute the following in the terminal:

auto-py-to-exe

Running Locally via Github (no install)

You can run this project locally by following these steps:

1. Clone/download the repo
2. Open cmd/terminal and cd into the project's root folder
3. Execute python -m pip install -r requirements.txt
4. Execute python -m auto_py_to_exe to run the application

Using the Application

1. Select your script location (paste in or use a file explorer)
   • The outline will become blue if the file exists
2. Select other options and add things like an icon or other files
3. Click the big blue button at the bottom to convert
4. Find your converted files in /output when completed

Easy.

Arguments

Use the help flag to get the usage: auto-py-to-exe --help

Argument	Type	Description
filename	positional/optional	Pre-fill the "Script Location" field in the UI.
-db, --default-browser	optional	Open the UI using the default browser (which may be Chrome). Will not try to find Chrome.
-nu, --no-ui	optional	Don't try to open the UI in a browser and simply print out the address where the application can be accessed.
-c [CONFIG], --config [CONFIG]	optional	Provide a configuration file (JSON) to pre-fill the UI. These can be generated in the settings tab.
-o [PATH], --output-dir [PATH]	optional	Set the default output directory. This can still be changed in the UI.
-bdo [FOLDER_PATH], --build-directory-override [FOLDER_PATH]	optional	Override the default build directory. Useful if you need to whitelist a folder to stop your antivirus from removing files.
-lang [LANGUAGE_CODE], --language [LANGUAGE_CODE]	optional	Hint the UI what language it should default to when opening. Language codes can be found in the table under "Translations" below.

JSON Configuration

Instead of inserting the same data into the UI over and over again, you can export the current state by going to the "Configuration" section within the settings tab and exporting the config to a JSON file. This can then be imported into the UI again to re-populate all fields.

This JSON config export action does not save the output directory automatically as moving hosts could mean different directory structures. If you want to have the output directory in the JSON config, add the directory under nonPyinstallerOptions.outputDirectory in the JSON file (will need to create a new key).

Examples

The examples/ directory offers some examples of how to write your scripts and package them with auto-py-to-exe.

• Basic (console application)
• No Console (as typically desired for GUI-based applications)
• Images and other non-.py files (static files to be included)
• Persistent data (like databases)

Video

If you need something visual to help you get started, I made a video for the original release of this project; some things may be different but the same concepts still apply.

Contributing

Check out CONTRIBUTING.md to see guidelines on how to contribute. This outlines what to do if you have a new feature, a change, translation update or have found an issue with auto-py-to-exe.

Issues Using the Tool

If you're having issues with the packaged executable or using this tool in general, I recommend you read my blog post on common issues when using auto-py-to-exe. This post covers things you should know about packaging Python scripts and fixes for things that commonly go wrong.

If you believe you've found an issue with this tool, please follow the "Reporting an Issue" section in CONTRIBUTING.md.

Translations

Language	Translators	UI	README	CONTRIBUTING	Examples
Arabic (العربية)	Tayeb-Ali	✔️
Belarusian (Беларуская)	Zmicier21	✔️⚠️	✔️
Brazilian Portuguese (Português Brasileiro)	marleyas, reneoliveirajr	✔️
Bulgarian (Български)	kbkozlev	✔️	✔️
Chinese Simplified (简体中文)	jiangzhe11, Emptylight	✔️	✔️	✔️
Chinese Traditional (繁體中文)	startgo	✔️
Czech (Čeština)	Matto58	✔️
Dutch (Nederlands)	barremans	✔️
English	-	✔️	✔️	✔️	✔️
Finnish (Suomen kieli)	ZapX5