Auto PY to EXE

By | March 19, 2024

Getting Started [From https://pypi.org/project/auto-py-to-exe/]

Prerequisites

  • Python : 3.6-3.12

To have the interface displayed in the images, you will need chrome. If chrome is not installed or –no-chrome is supplied, the default browser will be used.

As of PyInstaller 4.0, Python 2.7 is no longer supported. Read “Python 2.7 Support” below for steps on how to use this tool with Python 2.7.

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
  3. Execute python -m pip install -r requirements.txt

Now to run the application, execute python -m auto_py_to_exe. A Chrome window in app mode will open with the project running inside.

Make sure you are in the directory below auto_py_to_exe (you will be after step 3) when calling python -m auto_py_to_exe or you will need to reference the folder auto_py_to_exe absolutely/relatively to where you currently are.

Using the Application

  1. Select your script location (paste in or use a file explorer)
    • Outline will become blue when 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

Usage: auto-py-to-exe [-nc] [-c [CONFIG]] [-o [PATH]] [filename]

ArgumentTypeDescription
filenamepositional/optionalPre-fill the “Script Location” field in the UI.
-nc, –no-chromeoptionalOpen the UI using the default browser (which may be Chrome). Will not try to find Chrome.
-nu, –no-uioptionalDon’t try to open the UI in a browser and simply print out the address that the application can be accessed at.
-c [CONFIG], –config [CONFIG]optionalProvide a configuration file (json) to pre-fill the UI. These can be generated in the settings tab.
-o [PATH], –output-dir [PATH]optionalSet the default output directory. This can still be changed in the ui.
-bdo [FOLDER_PATH], –build-directory-override [FOLDER_PATH]optionalOverride 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]optionalHint the UI what language it should default to when opening. Language codes can be found in the table under “Translations” below.

If you are running this package locally, you will need to call python -m auto_py_to_exe instead of auto-py-to-exe

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).

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.

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 create an issue (click “Get started”) and fill out the template provided by the “Bug report” option. If your issue is only associated with your application, please do not create an issue in this repository – instead, comment on the help post, video or create a new discussion.

When filling out the template, be sure to clearly explain what’s happening, give reproduction steps and a minimal reproducible example and explain what you believe should have happened. Without these, it’s going to take longer to identify the issue.

Translations

LanguageTranslatorTranslated
Arabic (العربية)Tayeb-AliUI
Brazilian Portuguese (Português Brasileiro)marleyasreneoliveirajrUI
Bulgarian (Български)kbkozlevUI and README
Chinese Simplified (简体中文)jiangzhe11UI and README
Chinese Traditional (繁體中文)startgoUI
Czech (Čeština)Matto58UI
Dutch (Nederlands)barremansUI
EnglishUI and README
Finnish (Suomen kieli)ZapX5UI and README
French (Français)flaviedespUI
German (Deutsch)hebensackhhUI
Greek (Ελληνικά)sofronasUI
Indonesian (Bahasa Indonesia)MarvinZhongUI
Italian (Italiano)itsEmax64UI
Japanese (日本語)NattyanTVUI
Korean (한국어)jhk1090UI and README
Persian (فارسی)DrunkLeenAr.dstUI and README
Polish (Polski)AkuczakuUI
Russian (Русский)OlegUI
SerbianrinaUI
Spanish (Español)enriiqueeUI
Spanish Latam (Español Latam)MatyrelaUI
Thai (ภาษาไทย)teerut26UI (partial)
Turkish (Türkçe)mcagriaksoyUI and README
Ukrainian (Українська)AndrejGorodnijUI
Vietnamese (Tiếng Việt)7777HeckerUI

Want to add a translation for another language? Update i18n.js and submit a PR or attach it in an issue.

Python 2.7 Support

As of PyInstaller v4.0 released on Aug 9 2020, Python 2.7 is no longer supported; although you can still use this tool with Python 2.7 by installing an older version of PyInstaller. PyInstaller v3.6 was the last version that supported Python 2.7; to install this, first uninstall any existing versions of PyInstaller and then execute python -m pip install pyinstaller==3.6.

Testing

Tests are located in tests/ and are run using pytest:

$ pip install pytest
$ pip install -e .
$ pytest

Screenshots

Leave a Reply

Your email address will not be published. Required fields are marked *