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: Spatcholla/template-python-demo
- Preconfigured setup for Travis CI, Coveralls, and Scrutinizer
pyproject.toml
for managing dependencies and package metadataMakefile
for automating common development tasks:- Installing dependencies with
poetry
- Automatic formatting with
isort
andblack
- 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
- Installing dependencies with
- Tooling to launch an IPython session with automatic reloading enabled
- Visual Studio Code settings for linting and formatting
Install cookiecutter
and generate a project:
$ pip install cookiecutter
$ cookiecutter gh:Spatcholla/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.
Run the update tool, which is generated inside each project:
$ bin/update