Home

PyCompyle Wiki

Table of Contents

• Installation
• Usage
• Advanced Usage
• Contributing
• License

Installation

Requirements: Python 3.6 or higher.

To install PyCompyle:

1. Visit the Releases page for the latest version.
2. Download the installer.py script.
3. Run the installer with the python version that you wish to install it to:

python installer.py

This will install PyCompyle directly into your site-packages directory.

Usage

Basic command format:

python -m PyCompyle source_file.py

Arguments

• --noconfirm, -nc: Skip confirmation for wrapping the executable.
• --folder, -f: Build to a folder instead of a onefile executable.
• --zip, -zip: Build to a zip instead of a onefile exe (Zipped version of --folder).
• --bat, -bat: Use a .bat file for starting the built script instead of a .exe for faster start times (Windows only) (Implies --folder).
• --icon, -icon: Icon for the created EXE.
• --uac, -uac: Add UAC to the EXE.
• --package, -p: Include a package that might have been missed.
• --plugin, -pl: Load a plugin by path or name for built-in plugins.
• --midwaycommand, -m: Run a command or executable before building the EXE.
• --bootloader: Use a custom bootloader instead of the default ones. (Note: --uac and --windowed will not work).
• --verbose, -v: Enable verbose output.
• --windowed, -w: Disable console.
• --keepfiles, -k: Keep the build files.
• --copy, -copy: File(s) or folder(s) to copy into the build directory.
• --pyarg, -pyarg: Add arguments to the startup of the python interpreter.
• --include-script: Add a file located in PYTHONPATH/Scripts.
• --copy-include: Copy PYTHONPATH/include.
• --upx-threads: Threads to use for UPX compression (0 to disable).
• --disable-bootloader: Disable creating a bootloader executable (Implies --folder).
• --disable-python-environment: Disable copying the python environment (Implies --folder).
• --disable-compile: Disable compiling lib to .pyc files.
• --disable-lib-compressing: Disable compressing top-level .pyc and .py files in lib folder.
• --disable-password: Disable the password on the onefile EXE.
• --disable-dll: Disable copying the DLLs folder.
• --force-refresh: Remove the PyCompyle.cache folder and reinstall components.
• --debug: Enables all debugging tools: implies --verbose, --keepfiles, --folder; disables --windowed and --zip.

Plugins

The documentation for plugins can be found here

Contributing

Contributions are welcome! You can:

• Submit an issue for bugs or feature requests.
• Open a pull request to improve functionality.

License

This project is licensed under the terms specified in LICENSE.md.