Python Package Template

A Python library template with uv, Pydantic settings, loguru, pytest, Ruff, Git hooks, generated API docs and Conventional Commit releases. Supports Python 3.12–3.14.8.

Get started

With Make, Bash, Git and available:

git clone https://github.com/AmineDjeghri/python-package-template.git
cd python-package-template
make install-dev
make run

make help lists all commands.

Use the package

Download a wheel from this repository's GitHub Releases, then install that file:

uv pip install "/path/to/python_package_template-<version>-py3-none-any.whl"

from python_package_template.example import hello

hello()

Releases attach a wheel and sdist to GitHub and publish documentation on GitHub Pages; this template does not publish to a package index.

Guides

Task	Guide
Install tools, configure an editor or use Docker	Setup
Add code or settings	Project structure
Contribute a change	Contributing and conventions
Run tests and checks	Testing and test map
Publish or retry a release	Release
Start your own package	Fork this template

Use make deploy-doc-local to preview the documentation. For a frontend/backend application, see the Generative AI Project Template.

Created by Amine Djeghri.