My template for new Python libraries.
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
pyproject.toml
for managing dependencies and package metadataMakefile
for automating common development tasks:
poetry
isort
and black
pylint
mypy
pydocstyle
pytest
mkdocs
poetry
If you are instead looking for a Python application template, check out one of the sibling projects:
Here are a few sample projects based on this template:
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.
Run the update tool, which is generated inside each project:
$ bin/update