Cookiecutter PyPackage

Cookiecutter template for Python package.

Features

src project structure - how and why
Checks & tests with tox
- Formatting with black
- Check sorted imports with isort
- Code analysis with pylint
- Type checks with mypy
- Testing with pytest
pyproject.toml for configuration
CI and deployment to PyPI with GitHub Actions
Documentation with Sphinx
- Easy API documentation with autosummary
- Leverage type annotations for docs with sphinx-autodoc-typehints
Changelog based on Keep a Changelog

Quickstart

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

cookiecutter to load the template and fill the options

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

pyenv to setup different python versions

# Install some python versions.
pyenv install  3.7.5

# In the current directory, set the python version. This creates the file .python-version.
pyenv local 3.7.5

poetry to manage virtual environments

poetry env use fullpath_to_env
# Install a new package
poetry add numba

direnv to auto activate the virtual environment, Setup
```
echo "layout poetry" > .envrc
direnv allow
```

Create a GitHub repository and use git commands to link remote

cd my-new-tool
git init
git add .
git commit -m "Initial structure from template"
# Rename the 'master' branch to 'main':
git branch -m master main

Register your project with PyPI
Add API tokens as GitHub secrets for PyPI (PYPI_API_TOKEN) and Test PyPI (TEST_PYPI_API_TOKEN) for automated publishing
Add the repo to your Read the Docs account and activate the service hook
Release your package by pushing a new tag to master