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

Copier template for PDM projects
https://github.com/pdm-project/copier-pdm

copier copier-template project-template scafolding template

Last synced: 3 months ago
JSON representation

Copier template for PDM projects

• Host: GitHub
• URL: https://github.com/pdm-project/copier-pdm
• Owner: pdm-project
• License: mit
• Created: 2021-03-19T11:21:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T15:51:46.000Z (9 months ago)
• Last Synced: 2024-04-14T05:38:45.034Z (7 months ago)
• Topics: copier, copier-template, project-template, scafolding, template
• Language: Jinja
• Homepage: https://copier-pdm.fming.dev/
• Size: 918 KB
• Stars: 28
• Watchers: 4
• Forks: 12
• Open Issues: 1
• 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 - A Copier template for PDM projects (Eco-system)

README

        
# Copier PDM

Copier template for PDM projects.

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

You need to install [Copier](https://copier.readthedocs.io/en/stable/) first.

## Features

### Package manager

The template project uses [PDM](https://pdm.fming.dev) setup, with pre-defined `pyproject.toml`

### Documentation and changelog

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

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

- Changelog is auto-generated from the fragments under `news` directory, with the power of [towncrier](https://pypi.org/project/towncrier/)

### Pre-commit and linter

[pre-commit](https://pre-commit.com/) is used for both commit hook and linting, including the following hooks:

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

### VSCode default settings

The `.vscode/settings.json` will also be generated with the project, to enable Pylance auto-completions and test discovery in VSCode.

### Tests

- Tests run with [pytest](https://pytest.org/)

- Multi-environment testing powered by [nox](https://nox.thea.codes/)

## Requirements

Make below requirements are met to use the copier template:

- Python 3

- Git

- [Copier](https://copier.readthedocs.io/en/stable/)

## Quick Start

```bash

copier "https://github.com/pdm-project/copier-pdm.git" 

```

Or even shorter:

```bash

copier "gh:pdm-project/copier-pdm" 

```

See the [documentation](https://copier-pdm.fming.dev) for more details.