Setup⚓︎

Prerequisites⚓︎

In order to have no issues using this Template make sure the following software is installed.

Git v2, a version control system
Python 3, which can be managed with uv
Copier, the Python Program that creates the templates
uv, a Python Package Manager (optional)
just, the Taskrunner used inside the template (recommended)

Install Python⚓︎

Install uv with the following command.

curl -LsSf https://astral.sh/uv/install.sh | sh

And install Python with uv by running

uv python install 3.12

Note

This template supports Testing in Github Actions for Python 3.10, 3.12, and 3.14 (assuming the versions inbetween will work aswell). You can install multiple versions if needed:

uv python install 3.10 3.12 3.14

Install Copier⚓︎

Run the following commands to install Copier as a CLI Tool.

uvpipx

uv tool install copier --with copier-templates-extensions

pipx install copier
pipx inject copier copier-templates-extensions

Install Just⚓︎

uv has a nice interface to install tools. One of them is just. In order to install the just binary you can run

# Install just
uv tool install rust-just

Now you can invoke just Recipes by calling

# List all available recipes
$ just
Available Recipes:
    build  # build the package
    docs   # serve the dosumentation

# Execute a recipe
$ just docs
serving docs at https://localhost:8000