jxstanford / copier-pdm

Copier template for Python projects managed by PDM.

Copier PDM

Copier template for Python projects managed by PDM.

This copier template is mainly for my own usage, but feel free to try it out, or fork it!

Features

• Support for Insiders versions of projects (e.g. see @pawamoy's insiders)
• PDM setup, with pre-defined pyproject.toml
• Documentation built with MkDocs (Material theme and "autodoc" mkdocstrings plugin)
• Pre-configured tools for code formatting, quality analysis and testing:
  • black,
  • blacken-docs,
  • ruff,
  • mypy,
  • safety
• Tests run with pytest and plugins, with coverage support
• Cross-platform tasks with duty
• Support for GitHub workflows
• Python 3.8 or above
• Auto-generated CHANGELOG.md from git commits (using Angular message style)
• All licenses from choosealicense.com
• Makefile for convenience

Quick setup and usage

Make sure all the requirements are met, then:

copier copy --trust "https://github.com/pawamoy/copier-pdm.git" /path/to/your/new/project

Or even shorter:

copier copy --trust "gh:pawamoy/copier-pdm" /path/to/your/new/project

See the documentation for more details.