Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.42 KB

README.md

File metadata and controls

42 lines (32 loc) · 1.42 KB

PDM Copier

Copier template for Python projects managed by PDM.

This copier template is mainly for my own usage, but feel free to try it out, or fork it!

Features

  • PDM setup, with pre-defined pyproject.toml
  • Documentation built with pdoc3
  • Pre-configured tools for code formatting, quality analysis and testing:
  • Tests run with pytest and plugins, with coverage support
  • Support for Gitlab CI
  • Python 3.8 or above
  • Auto-generated CHANGELOG.md from git commits (using Angular message style)
  • All licenses from choosealicense.com

Quick setup and usage

Make sure all the requirements are met, then:

copier "https://gitlab.com/ydethe/pdm-copier" /path/to/your/new/project

Or even shorter:

copier "gl:ydethe/pdm-copier" /path/to/your/new/project

See the documentation for more details.