README.md

Python project template

An opinionated Copier template for Python projects managed by uv.

Features

• CLI and autocompletion with Typer.
• Rust extensions with maturin.
• Pre-configured tools for code formatting, quality analysis, documentation and testing:
  • ruff
  • mypy or ty
  • pytest
  • sphinx (furo theme)
  • uv audit
• Task automation with just.
• Support for GitHub actions and GitHub pages.

Quickstart

First, install Copier.

Then, to create a new project based on this template, run the following command and fill in the form:

copier copy 'https://github.com/vivienm/copier-python' path/to/your/project

Go to the project directory and upgrade the dependencies to start on a fresh base:

uv lock --upgrade

Then run the tests:

just ci

You are now ready to start coding!

Later, to update your project as this template evolves, run:

copier update --skip-answered