Cookiecutter PyPackage

Cookiecutter template for a Python package.

• GitHub repo: https://github.com/pyfar/cookiecutter-pypackage/
• Forked from: https://github.com/audreyfeldroy/cookiecutter-pypackage/
• Documentation: https://cookiecutter-pypackage.readthedocs.io/
• Free software: BSD license

Features

• Testing setup with unittest and python setup.py test or pytest
• Circleci: Ready for Circleci Continuous Integration testing, ruff and deployment
• Sphinx docs: Documentation ready for generation with, for example, Read the Docs
• bump2version: Pre-configured version bumping with a single command
• Auto-release to PyPI when you push a new tag to master (optional)
• Command line interface using Click (optional)
• Readme and Contributing guidelines and code of conduct from pyfar
• add minimum python version and create supported versions in setup.py and .circleci/conf automaticly

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/pyfar/cookiecutter-pypackage.git

Then:

• Create a repo and put it there.
• Add the repo to your Circleci account.
• Install the dev requirements into a virtualenv. (pip install -r requirements_dev.txt)
• Register your project with PyPI.
• Add the repo to your Read the Docs account + turn on the Read the Docs service hook and activate it for pull requests.
• Release your package using bump2version (see Contributing).
• Add a requirements.txt file that specifies the packages you will need for your project and their versions. For more info see the pip docs for requirements files.
• Activate your project on pyup.io.

For more details, see the cookiecutter-pypackage tutorial.

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

• Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
• It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.