cookiecutter gh:a1d4r/python-project-template --checkout main

In this cookiecutter 🍪 template we combine state-of-the-art libraries and best development practices for Python.

• Supports Python 3.9 - 3.13
• uv as a package manager.
• Automatic codestyle with ruff formatter
• Linting with ruff
• Type checks with mypy, security checks with safety.
• Dependencies check with deptry
• Testing with pytest and coverage.
• Runtime type checking in tests with typeguard.
• Ready-to-use pre-commit hooks with code-formatting.
• Ready-to-use .editorconfig, .dockerignore, and .gitignore.

• Github Actions with linters and tests in the workflow.
• Gitlab CI with linters and tests in the pipeline. Click here for a detailed overview.
• Ready-to-use Makefile with formatting, linting, and testing. More details in makefile-usage.
• Dockerfile for your package.
• docker-compose.yml for local development in Docker.

To begin using the template consider updating cookiecutter

pip install -U cookiecutter

then go to a directory where you want to create your project and run:

cookiecutter gh:a1d4r/python-project-template --checkout main

Template generator will ask you to fill some variables.

The input variables, with their default values:

All input values will be saved in the cookiecutter-config-file.yml file so that you won't lose them. 😉

Your project will contain README.md file with instructions for development, deployment, etc. You can read the project README.md template before.

By running make install

After you create a project, it will appear in your directory, and will display a message about how to initialize the project.

By running make pre-commit-install. Make sure to set up git first via git init.

Makefile contains a lot of functions for faster development.

To download and install uv run:

make uv-install

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

Automatic formatting uses ruff formatter

make codestyle

# or use synonym
make format

Codestyle checks only, without rewriting files:

make check-codestyle

Update all libraries to the latest version using one command

make update

This command identifies security issues with Safety

make check-safety

Run mypy static type checker

make mypy

Run pytest

make test

Of course there is a command to rule run all linters in one:

make lint

Run with docker compose

make docker-up

Delete cache and build files:

make cleanup

This template was initially forked from the following template:

• 🚀 Your next Python package needs a bleeding-edge project structure.