jacebrowning/template-python

My template for new Python libraries.

Jace's Python Template

This is a cookiecutter template for a typical Python library following modern packaging conventions. It utilizes popular libraries alongside Make and Graphviz to fully automate all development and deployment tasks. Check out the live demo: jacebrowning/template-python-demo

Features

• Preconfigured setup for CI, coverage, and analysis services
• pyproject.toml for managing dependencies and package metadata
• Makefile for automating common development tasks:
  • Installing dependencies with poetry
  • Automatic formatting with isort and black
  • Static analysis with pylint
  • Type checking with mypy
  • Docstring styling with pydocstyle
  • Running tests with pytest
  • Building documentation with mkdocs
  • Publishing to PyPI using poetry
• Tooling to launch an IPython session with automatic reloading enabled

If you are instead looking for a Python application template, check out one of the sibling projects:

• jacebrowning/template-django
• jacebrowning/template-flask

Examples

Here are a few sample projects based on this template:

• jacebrowning/minilog
• theovoss/Chess
• sprout42/StarStruct
• MichiganLabs/flask-gcm
• flask-restful/flask-restful

Usage

Install cookiecutter and generate a project:

$ pip install cookiecutter
$ cookiecutter gh:jacebrowning/template-python -f

Cookiecutter will ask you for some basic info (your name, project name, python package name, etc.) and generate a base Python project for you. Once created, run the code formatter to updates files based on your chosen names:

$ cd <github_repo>
$ make format

Finally, commit all files generated by this template.

Updates

Run the update tool, which is generated inside each project:

$ bin/update