copier-pdm

Copier PDM

Copier template for Python projects managed by PDM.

[!WARNING] I personally don’t use this template anymore, so it is maintained by the community. I will still review and merge PRs though. I can add you as a contributor if you wish to maintain the template for the community (for personal needs, please fork instead).

Similar templates:

• copier-poetry, with Poetry
• copier-uv, with uv

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.