Cookiecutter template for a Python package.

• GitHub repo: https://github.com/johanvergeer/cookiecutter-poetry/
• Documentation: https://cookiecutter-poetry.readthedocs.io/
• Free software: MIT license

• Testing setup with pytest
• Github Actions: Ready for GitHub actions
• Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
• Auto-release to PyPI when you push a new tag to master (optional)
• Command line interface using Click (optional)
• GitHub Issue templates for bug reports and feature requests

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/johanvergeer/cookiecutter-poetry.git

Then:

• Create a repo and put it there.
• Create virtual environment and install project dependencies. (poetry install)
• Run the Travis CLI command travis encrypt --add deploy.password to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
• Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
• Release your package by pushing a new tag to master.

For more details, see the cookiecutter-poetry tutorial.

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.

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.