Template

---

Introduction

In this section you can provide a brief introduction to the project. You can also include a brief description of the project and its features.

Using this template: click Use this template on GitHub. The first push runs the Initialize from template workflow, which renames project-name/project_name after your repository, fixes the badges and URLs, refreshes uv.lock, verifies the result and commits it. Delete this note afterwards. To do it by hand: python scripts/init_from_template.py --owner <you> --repo <name>.

Table of Contents 🗂

• Key Features
• Installation
• Usage
• Citation
• Contributing
• License

Key Features 🔑

This section is optional. If your project has a lot of features, consider adding a list of key features here.

Installation ⚙️

Requires Python 3.10 or newer.

uv tool install git+https://github.com/StephanAkkerman/template.git
# or: pip install git+https://github.com/StephanAkkerman/template.git

For development you need uv:

git clone https://github.com/StephanAkkerman/template.git
cd template
make install   # uv sync (creates .venv from uv.lock) + pre-commit hooks
make check     # ruff, ty and pytest: the same gates as CI

Dependencies are declared in pyproject.toml and pinned in uv.lock (there is no requirements.txt). Add one with uv add <package>.

Usage ⌨️

project-name --help

See .env.example for configuration.

Citation ✍️

If you use this project in your research, please cite as follows:

@misc{project_name,
  author  = {Stephan Akkerman},
  title   = {Project Name},
  year    = {2026},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/StephanAkkerman/template}}
}

Contributing 🛠

Contributions are welcome! If you have a feature request, bug report, or proposal for code refactoring, please feel free to open an issue on GitHub. We appreciate your help in improving this project.

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.