dmcc / copier-pdm

Copier template for PDM projects [dmcc's version]

Copier PDM

Copier template for PDM projects.

This copier template is mainly for my own usage, but feel free to try it out, or fork it! Original version is pdm-project/copier-pdm.

Features

Package manager

The template project uses PDM setup, with pre-defined pyproject.toml

Documentation and changelog

• Documentation is built with MkDocs (Material theme)
• Changelog is auto-generated from the fragments under news directory, with the power of towncrier

Pre-commit and linter

pre-commit is used for both commit hook and linting, including the following hooks:

• ruff
• keep-sorted
• do-not-submit

Tests

• Tests run with pytest. GitHub Actions provide matrix support.

Requirements

Make below requirements are met to use the copier template:

• Python 3
• Git
• Copier
• PDM

Quick Start

1. Install PDM with Copier support:

   pip install --user "pdm[copier]"

2. You can use PDM to initialize a project directly from the template. First, make a directory for the project, then inside that directory run:

   pdm init --copier "gh:dmcc/copier-pdm"

Alternatively:

2. Set up a new project with this template: (this will create the project directory for you)

   copier copy --trust "gh:dmcc/copier-pdm" <project_name>