vivienm/copier-python-pdm

An opinionated Copier template for Python projects

Python project template

An opinionated Copier template for Python projects managed by PDM.

Features

• src directory layout.
• PDM setup, with generated pyproject.toml.
• Pre-configured tools for code formatting, quality analysis, documentation and testing:
  • ruff
  • mypy
  • pytest
  • sphinx with furo theme
  • pip-audit
• Tests run with Nox.
• Support for GitHub actions and GitHub pages.

Quickstart

To install Copier, please follow the installation instructions here.

You will also need to install PDM, the installation instructions can be found here.

Then, to create a new project based on this template, run:

copier copy --trust 'https://github.com/vivienm/copier-python-pdm' path/to/your/project

and fill in the form.

You may want to update the dependencies to their latest versions (in a distinct commit, to prevent conflicts when updating the template):

pdm update --update-all --unconstrained

To update an existing project based on this template, run:

copier update --skip-answered --trust