Comprehensive packaging and testing for your Python projects

This project is meant to be forked into new Python3 projects using the tools/fork.py script. See tools/fork.py --help for the many command line options available. See the usage document to understand the workflow of creating a new project and using the template and tooling.

Features

• Comprehensive packaging options for all major desktop and server platforms, easily deploy your cross-platform Python code to nearly any computer in the world
• 100% unit test coverage out of the box
• Clean separation of business logic from presentation
• Well organized and extensible structure
• tools/fork.py: Project forking script to customize which components your project includes
• tools/vendor.sh Python package vendoring; Transparently store dependencies within your own package, useful when packaging for Linux distros that do not have all of the required dependencies / versions available in the OS package manager
• Run your unit tests in Docker or Podman against every version of Python that your code supports using make test-all-docker, or use tox if you have all required Python versions installed locally
• Makefile: Many development and build tasks are automated using the make command. See the Makefile source code for details.
• Boilerplate configs for popular public cloud CI services
• Generate tab completion scripts for bash and zsh

• Generate man pages for your CLI applications

Advanced packaging

• AppImage (one-file desktop and CLI portable executables that work on nearly all Linux distributions)
• Debian (Debian / Ubuntu / etc...)
• Docker
• macOS app bundle in pkg or dmg
• pypi / pip
• RPM (Red Hat / Fedora / OpenSUSE / etc...)
• Windows installers and single-file portable executables

Included optional user interfaces

• Shared library
• command subcommand subcommand CLI with tab completion
• Qt5 and Qt6 UI, flexibly use either in the same codebase using our compatibility layer
• SDL2 game
• RESTful API
• ...or build your own

The src/pytemplate module is the base library that should contain all of your application logic. User interfaces to the library are created as additional modules, for example: src/pytemplate_cli, src/pytemplate_qt, src/pytemplate_rest with corresponding commands in the scripts/ directory to invoke each interface

Usage

See the documentation folder