In Python, scripting is fun! However, writing a compiled, versioned, stand-alone Python application for Windows is not. This template helps with the latter, assuming you're happy with Nuitka for compilation, conda for environment management, and git for version control. Everything is glued together through the magic of shudders batch scripts.
- Anaconda or miniconda.
- Git.
- After downloading the template, edit
project_name.txtto contain your project's name. This will be the name of the compiled executable, the folder containing it, and your conda environment. - Create a new conda environment with the name matching
project_name.txt. pip install semantic-version nuitka(within activated conda environment).cd <project dir>rm -rf .gitgit init
Your program's entry point is src/main.py. Any files you place in the resources folder will be available in both the scripted and compiled versions of your program; see how main.py reads resources/version.txt.
Use the scripts to compile your code and manage its version, although you're always free to edit resources/version.txt manually. All scripts must be called from the root directory (NOT the scripts directory) with the anaconda environment enabled.
export-conda-environment.cmd: Exports the conda environment to .yml (includes pip requirements).compile.cmd: Compilessrc/main.pytodist/<project-name>, copying over the resources folder in the process.zip-distributable.cmd: Creates a zipped archive of the compiled code with filename<project-name>-v<version-number>.zip. The version number is obtained fromresources/version.txt.make_release.cmd: A combination of the above scripts; run this when you're ready to release a new version. Does the following:- increments the version number
- updates the conda requirements
- git tags the release (includes incremented version number and updated conda requirements)
- compiles the code
- zips the build into an archive with versioned filename
Remember to push your tags!