https://github.com/fpgmaas/cookiecutter-pdm

A modern cookiecutter template for Python projects that use PDM for dependency management
https://github.com/fpgmaas/cookiecutter-pdm

boilerplate cookiecutter cookiecutter-python pdm python template

Last synced: about 2 months ago
JSON representation

A modern cookiecutter template for Python projects that use PDM for dependency management

• Host: GitHub
• URL: https://github.com/fpgmaas/cookiecutter-pdm
• Owner: fpgmaas
• License: mit
• Created: 2023-09-04T05:47:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-05T10:42:23.000Z (over 1 year ago)
• Last Synced: 2024-08-09T02:56:15.354Z (5 months ago)
• Topics: boilerplate, cookiecutter, cookiecutter-python, pdm, python, template
• Language: Python
• Homepage: https://fpgmaas.github.io/cookiecutter-pdm/
• Size: 1.03 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  



---

[![Release](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-pdm)](https://pypi.org/project/cookiecutter-pdm/)

[![Build status](https://img.shields.io/github/actions/workflow/status/fpgmaas/cookiecutter-pdm/main.yml?branch=main)](https://github.com/fpgmaas/cookiecutter-pdm/actions/workflows/main.yml?query=branch%3Amain)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-pdm)](https://pypi.org/project/cookiecutter-pdm/)

[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://fpgmaas.github.io/cookiecutter-pdm/)

[![License](https://img.shields.io/github/license/fpgmaas/cookiecutter-pdm)](https://img.shields.io/github/license/fpgmaas/cookiecutter-pdm)

This is a modern Cookiecutter template that can be used to initiate a Python project with all the necessary tools for development, testing, and deployment. It supports the following features:

- [PDM](https://pdm.fming.dev/latest/) for dependency management

- CI/CD with [GitHub Actions](https://github.com/features/actions)

- Pre-commit hooks with [pre-commit](https://pre-commit.com/)

- Code quality with [black](https://pypi.org/project/black/), [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), and [deptry](https://github.com/fpgmaas/deptry/)

- Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub

- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)

- Documentation with [MkDocs](https://www.mkdocs.org/)

- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)

- Containerization with [Docker](https://www.docker.com/)

---



  Documentation - Example -

  PyPi



---

## Quickstart

On your local machine, navigate to the directory in which you want to

create a project directory, and run the following two commands:

``` bash

pip install cookiecutter-pdm

ccpdm

```

Alternatively, install `cookiecutter` and directly pass the URL to this

Github repository to the `cookiecutter` command:

``` bash

pip install cookiecutter

cookiecutter https://github.com/fpgmaas/cookiecutter-pdm.git

```

Create a repository on GitHub, and then run the following commands, replacing ``, with the name that you gave the Github repository and

`` with your Github username.

``` bash

cd 

git init -b main

git add .

git commit -m "Init commit"

git remote add origin [email protected]:/.git

git push -u origin main

```

Finally, install the environment and the pre-commit hooks with

 ```bash

 make install

 ```

You are now ready to start development on your project! The CI/CD

pipeline will be triggered when you open a pull request, merge to main,

or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see

[here](https://fpgmaas.github.io/cookiecutter-pdm/features/publishing/#set-up-for-pypi).

For activating the automatic documentation with MkDocs, see

[here](https://fpgmaas.github.io/cookiecutter-pdm/features/mkdocs/#enabling-the-documentation-on-github).

To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-pdm/features/codecov/).

## Acknowledgements

This project is partially based on [Audrey

Feldroy\'s](https://github.com/audreyfeldroy)\'s great

[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)

repository.