Awesome
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!
You need to install Copier first.
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:
VSCode default settings
The .vscode/settings.json
will also be generated with the project, to enable Pylance auto-completions and test discovery in VSCode.
Tests
Requirements
Make below requirements are met to use the copier template:
- Python 3
- Git
- Copier
Quick Start
copier "https://github.com/pdm-project/copier-pdm.git" <project_name>
Or even shorter:
copier "gh:pdm-project/copier-pdm" <project_name>
See the documentation for more details.