Skip to content

Repository files navigation

copier-minimal-python

CI License: MIT

A minimal copier template for Python projects with uv, pytest, ruff, and optional CLI support.

Features

  • uv for dependency management
  • pytest for testing
  • ruff for linting and formatting
  • ty for type checking
  • prek for commit-time checks
  • Optional Typer CLI
  • GitHub Actions CI/CD workflows
  • MIT license

Usage

uvx copier copy gh:jooh/copier-minimal-python my-project

Or with copier installed:

copier copy gh:jooh/copier-minimal-python my-project

Template options

Option Description Default
project_name Project name (kebab-case) -
package_name Python package name (snake_case) derived from project_name
description One-line project description -
min_python_version Minimum Python version 3.12
has_cli Include Typer CLI true
author_name Author name -
repo_owner GitHub username/org -

Development

Set up the development environment and install the commit-only Git hook once:

make bootstrap

Run the template tests and, when needed, every prek check against all tracked files:

make test
make prek

The installed hook runs automatically on git commit. Safe formatting fixes must be reviewed and staged before retrying the commit; no pre-push or other Git hooks are installed.

See AGENTS.md for more details on the template structure.

About

Minimalistic template for Python packages with uv

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages