This is a GitHub Action that builds stand-alone Windows, Mac, and Linux executable binaries from a python script using the amazing nuitka python compiler.
- Build Stand-along Executables - Build a executable from your python script (stand-alone *.exe or *.bin file executables and even .app bundles for Mac)
- Build Binary Python Modules - Build binary *.pyd modules that can be imported into other python scripts
- Mac, Linux, and Windows - Support for Windows, Mac (including .app bundles), and Linux
- GUI Support - Supports GUIs made e.g. with tkinter and Qt (PyQt6, and PySide6)
- Lots More! - All the features of Nuitka Python Compiler including support for Nuitka Commercial Features like obfuscation, embedding data files, and more (for those with a license).
See Usage Details below for more info.
## hello_world.py
print("hello world!")Run it in python
C:\> python hello_world.py
hello world!
Use this action as a step in one of your project's CI workflow jobs (details below):
# Build python script into a stand-alone exe
- uses: Nuitka/Nuitka-Action@main
with:
nuitka-version: main
script-name: hello_world.pyC:\> hello_world.exe
hello world!
-
Not all Nuitka options are currently exposed as input parameters to this action. We welcome PRs in case you find anything missing.
-
The version of the Nuitka package (and its dependencies) are currently hard-coded. Eventually, we'll add support for you to specify versions of these packages -- probably just by disabling installing these packages as part of the action so you can do it in your workflow.
-
Not many examples yet that demonstrate how to use this action in practice.
| Project | Example Workflow (YAML) |
|---|---|
| Node Editor GUI using Qt/Pyside6 |  |
| Kasa TP-Link CLI App |  |
See action.yml for details on how this action works under the hood. It is actually pretty simple.
See jimkring/test-nuitka-action/ for examples of this workflow in action.
jobs:
build:
# Windows is currently the only platform this action supports
runs-on: windows-latest
steps:
# Check-out repository
- uses: actions/checkout@v3
# Setup Python
- uses: actions/setup-python@v4
with:
python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
# Build python script into a stand-alone exe
- uses: Nuitka/Nuitka-Action@main
with:
nuitka-version: main
script-name: hello_world.py
onefile: true
# Uploads artifact
- name: Upload Artifact
uses: actions/upload-artifact@v3
with:
name: exe
path: build/hello_world.exeSimilar to the others, but with enable-plugins: pyside6 or enable-plugins:tk-inter to
ensure that those libraries are included correctly.
- name: Qt GUI with Pyside6
uses: Nuitka/Nuitka-Action@main
with:
nuitka-version: main
script-name: my_qt_gui_app.py
standalone: true
enable-plugins: pyside6- name: Python GUI With Tkinter
uses: Nuitka/Nuitka-Action@main
with:
nuitka-version: main
script-name: my_tkinter_gui_app.py
standalone: true
enable-plugins: tk-interTo build for a given platform, just choose a runner of the appropriate operating system. You can even build for multiple platforms in a single workflow using a matrix strategy, as shown below:
Here we see a workflow from the jimkring/kasa-cli project.
jobs:
build:
strategy:
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Check-out repository
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10' # Version range or exact version of a Python version to use, using SemVer's version range syntax
architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
cache: 'pip'
cache-dependency-path: |
**/requirements*.txt
- name: Install Dependencies
run: |
pip install -r requirements.txt -r requirements-dev.txt
- name: Build Executable
uses: Nuitka/Nuitka-Action@main
with:
nuitka-version: main
script-name: kasa_cli
onefile: true
- name: Upload Artifacts
uses: actions/upload-artifact@v3
with:
name: ${{ runner.os }} Build
path: |
build/*.exe
build/*.bin
build/*.app/**/*And, here's what a resulting job run looks like:
https://github.com/jimkring/kasa-cli/actions/runs/2682890462
You can see that executable binaries were created for Mac, Linux, and Windows.
This action installs the following python packages (which are specified in the requirements.txt of this action repo).
ordered-set==4.1.0
# via -r requirements.in
wheel==0.38.4
# via -r requirements.in
zstandard==0.20.0
See Nuitka for full documentation on Nuitka. It's really a fantastic tool!
The scripts and documentation in this project are released under the MIT License.
Nuitka is licensed under the Apache 2.0 License
Python is licensed under the Python Software Foundation (PSF) License.
This tool compiles and/or copies your project's package dependencies (and their dependencies) into the output executable, which will be considered a combined and/or derivative work of those packages.
Important: You are responsibile for compliance with the licenses of your project's package dependencies. Please consult with an attorney about your individual/project's compliance needs and strategy.
There are some great license checker tools that you might consider integrating with your project. Generally speaking, they enable you to specify which licenses (or types) are approved or disaproved and alert you whenever your project has a package dependency that is not approved.
Here are a couple license checker tools:
- python-license-check - can be run as a GitHub pre-commit hook.
- dependencies-license-compliance-checker - a github action that can be run before your executable build.