https://github.com/pawamoy/copier-pdm

Copier template for Python projects managed by PDM.
https://github.com/pawamoy/copier-pdm

bootstrapping copier copier-template pdm python scaffolding template

Last synced: about 2 months ago
JSON representation

Copier template for Python projects managed by PDM.

• Host: GitHub
• URL: https://github.com/pawamoy/copier-pdm
• Owner: pawamoy
• License: isc
• Created: 2021-04-04T22:03:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-13T13:10:31.000Z (9 months ago)
• Last Synced: 2024-10-23T11:13:03.187Z (2 months ago)
• Topics: bootstrapping, copier, copier-template, pdm, python, scaffolding, template
• Language: Jinja
• Homepage: https://pawamoy.github.io/copier-pdm
• Size: 2.27 MB
• Stars: 85
• Watchers: 3
• Forks: 18
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-pdm - copier-pdm - Another Copier template for Python projects managed by PDM (Eco-system)

README

        
# Copier PDM

[![ci](https://github.com/pawamoy/copier-pdm/workflows/ci/badge.svg)](https://github.com/pawamoy/copier-pdm/actions?query=workflow%3Aci)

[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/copier-pdm/)

[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#copier-pdm/community:gitter.im)

[Copier](https://github.com/copier-org/copier) template

for Python projects managed by [PDM](https://github.com/pdm-project/pdm).

This copier template is mainly for my own usage,

but feel free to try it out, or fork it!

Similar templates:

- [copier-poetry](https://github.com/pawamoy/copier-poetry), with [Poetry](https://github.com/python-poetry/poetry)

- [copier-uv](https:///github.com/pawamoy/copier-uv), with [uv](https://github.com/astral-sh/uv)

## Features

- Support for Insiders versions of projects (e.g. see [@pawamoy's insiders](https://pawamoy.github.io/insiders/))

- [PDM](https://github.com/pdm-project/pdm) setup, with pre-defined `pyproject.toml`

- Documentation built with [MkDocs](https://github.com/mkdocs/mkdocs)

  ([Material theme](https://github.com/squidfunk/mkdocs-material)

  and "autodoc" [mkdocstrings plugin](https://github.com/mkdocstrings/mkdocstrings))

- Pre-configured tools for code formatting, quality analysis and testing:

    - [black](https://github.com/psf/black),

    - [blacken-docs](https://github.com/adamchainz/blacken-docs),

    - [ruff](https://github.com/charliermarsh/ruff),

    - [mypy](https://github.com/python/mypy),

    - [safety](https://github.com/pyupio/safety)

- Tests run with [pytest](https://github.com/pytest-dev/pytest) and plugins, with [coverage](https://github.com/nedbat/coveragepy) support

- Cross-platform tasks with [duty](https://github.com/pawamoy/duty)

- Support for GitHub workflows

- Python 3.8 or above

- Auto-generated `CHANGELOG.md` from git commits (using Angular message style)

- All licenses from [choosealicense.com](https://choosealicense.com/appendix/)

- Makefile for convenience

## Quick setup and usage

Make sure all the

[requirements](https://pawamoy.github.io/copier-pdm/requirements)

are met, then:

```bash

copier copy --trust "https://github.com/pawamoy/copier-pdm.git" /path/to/your/new/project

```

Or even shorter:

```bash

copier copy --trust "gh:pawamoy/copier-pdm" /path/to/your/new/project

```

See the [documentation](https://pawamoy.github.io/copier-pdm)

for more details.