Cookiecutter PyPackage

Cookiecutter template for a Python package, forked from briggySmalls/cookiecutter-pypackage.

• GitHub repo: https://github.com/nathanhhughes/cookiecutter-pypackage/
• Free software: BSD license

Features

This template is based on `_briggySmalls/cookiecutter-pypackage`_, but makes a few changes:

• Linting only provided by flake8 [executed by Tox]
• Formatting provided by black and isort [checked by Tox]
• isort and flake8 configuration to deconflict from black
• Napoleon sphinx extension automatically added (not optional)
• ReadTheDocs sphinx format is the default style for sphinx
• No Travis or Appveyor support for this repo
• No travis or pyup support in the template

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/nathanhhughes/cookiecutter-pypackage.git

Then:

• Create a repo and put it there.
• Install the dev requirements into a virtualenv. (poetry install)
• Release your package by pushing a new tag to master.
• Get your code on! Add your package dependencies as you go, locking them into your virtual environment with poetry add.