README.md

Copier PDM and Nox

Copier template for Python projects managed by PDM with the help of Nox.

Features

• PDM is used as a dependency manager, with pre-defined pyproject.toml.
• Nox for running development tasks in multiple Python environments, with a pre-defined noxfile.py.
• Documentation built with MkDocs using Material theme and mkdocstrings plugin.
• Tools for code formatting:
  • black
  • docformatter
• Tools for checking code quality:
  • ruff
• Tools for checking safety vulnerabilities:
  • safety
• Tools for checking type annotations:
  • mypy
• Tests run with pytest and plugins, with coverage support.
• CHANGELOG.md managed by git-changelog.
• Support for GitHub Actions.
• All licenses from choosealicense.com.
• Python 3.8 or above.

Prerequisites

To use the template's development tasks, the following command-line tools are required:

• PDM (>= 2.9.0)
• Nox (>=2023.4.22)
• Git (>= 2.30.0)
• GitHub CLI (>= 2.25.0)

Usage

To use the template for a new project:

copier copy "gh:georgedouzas/copier-pdm-nox.git" /path/to/your/new/project

To update the project using a new version of the template:

copier update

Credits

This template is based on copier-pdm from Timothée Mazzucotelli. You may also check his other amazing projects.