Cookiecutter Python Package Template

About • Usage • Releases • Support • Donate

---

About

Cookiecutter is a Python package to generate templated projects. This repository is a template for cookiecutter to generate a Python project which contains following: A directory structure for your project Poetry package manager Prebuilt pyproject.toml file to help you develop and install your package Continuous integration - Preconfigured to generate project documentation - Preconfigured to automatically run tests every time you push to GitHub - Preconfigured to help you release your package publicly (PyPI)

Usage

To use this template use the following commands and then follow the prompts from the terminal.

1. pip install cookiecutter
2. cookiecutter gh:totaldebug/python-package-template

Then:

• Create a repo and put it there.
• Add a secret to github for PyPi Token with name pypi_password
• Install the dev requirements make install
• Release your package by pushing a new tag to master.

Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use action gh-release. As new version tags are created, release will be generated listing the changes. You can categorize pull requests in release notes using labels.

List of labels and corresponding titles

You can update it in release.yml.

Support

Reach out to me at one of the following places:

• Discord
• Discussions
• Issues

Donate

Please consider supporting this project by sponsoring, or just donating a little via our sponsor page.

🛡 License

This project is licensed under the terms of the license. See LICENSE for more details.