Ge0 / 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:
  • black
  • isort
  • flake8 with pydocstyle plugin
  • mypy
  • pytest
  • sphinx with furo theme
  • safety
• Tests run with Nox.
• Support for GitHub actions and GitHub pages.

Quickstart

Make sur all the requirements are met, then:

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

Or even shorter:

copier 'gh:vivienm/copier-python-pdm' /path/to/your/new/project

Requirements

To use this Copier template, you will need:

• Git
• Python 3
• Copier
• PDM

Copier

To install copier, you may follow its installation instructions or use pipx:

pipx install copier

PDM

To install PDM, you may follow its installation instructions, or use pipx:

pipx install pdm