Python, now with 39% more GUI 🐍💻

Template for pythons apps with a GUI. Features automated builds on release with binaries for Windows, MacOS and Linux users to download. Contains linting, formatting and testing tools.

Although this template is meant to be a base for bigger projects, there are some limitations and annoyances that derive from using python bindings with Qt. To name a few, testing can be cumbersome with PyTest-Qt and the API is not always easy to work with or well documented. Other than that, there is also no tooling for using Qt translations with ease so this template essencially provides a non-localized app, this is not to say that it can't be added when building upon it.

With the exception of the points above, we believe this template to be decently production ready.

Usage 🚀

• The app is automatically built by a pipeline with every release, so we provide direct download links for most operating systems.

• Windows 🪟

  • Use this link to start the download.

  • Start the main.exe file inside the extracted folder by double clicking on it, you can create a shortcut with any name you like for this file.

  • If you get a message from Windows with a warning that blocks the app from running, look for the hidden continue button and use it to safely ignore this warning.

• Linux 🐧

  • Use this link to start the download.

  • Start the main.bin file inside the extracted folder, remember to update the execution permissions first by opening a terminal and running:

    chmod +x main.bin
    ./main.bin

  • This binary has been successfully tested on Ubuntu and Arch with both the Wayland and X11 protocols, other setups may need additional tinkering.

• MacOS 🍎

  • Use this link to start the download.

  • Start the extracted bundle app by clicking on it.

  • If the app fails to open, go to this support page and select your OS version at the top, then follow the instructions.

Development 🛠️

• Requirements 📋

  • Python 3.12.0+

• Setup ⚙️

  • Clone the repository and open a terminal inside it.

  • Install the dependencies:

    # It is it recommend that a virtual environment is set before doing this!
    
    pip install .

  • Start the app:

    python src/main.py

• Tooling 🧰

  • Ruff is used as a linter and formatter:

    pip install .[check]
    ruff check --fix
    ruff format
    
    # To automatically lint and format on every commit install the pre-commit hooks:
    pre-commit install
    
    # When using pre-commit hooks, git commands will fail if any files are checked with errors.
    # Changed files must be added to the staged area and commited again to apply fixes.

  • PyTest and PyTest-Qt are used for testing:

    pip install .[test]
    pytest

  • Nuitka is used for cross-compiling to all supported platforms:

    pip install .[build]
    nuitka <options>

    See the build workflow for a list of options used for each platform.

Notes 📝

When using this repository as a template make sure to:

• Edit the project name and version in the pyproject.toml file.

• Edit the constants that refer to the app in the utils/constants.py file.

• Change the env variables in the build.yaml workflow for the final build manifest.

• Update the description and hard coded repository links in this README.md, specifically the download links.

• Delete these notes.