Skip to content

README.md

Latest commit

 

History

History
48 lines (35 loc) · 1.47 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.47 KB

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
  • pyright for type checking
  • 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

make test

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