easy-as-pypi

Boilerplate PyPI project.

Overview

Boilerplate for modern, bathroom-tub-included Python projects.

The boilerplate itself is installable and includes minimalist Click CLI.

But most of the gold is buried within:

• Modern Poetry and pyproject.toml setup.

• Supports cascading editable installs (install current project in editable mode, as well as any dependencies you might have source for locally; boilerplate manages alternative pyproject.toml automatically).

• All the lints: black, flake8, isort, pydocstyle, doc8, linkcheck, poetry check, and twine check.

• Test against all active Python versions and lint using tox.

• Run tasks, tests, and setup virtualenvs quickly using make commands in your active virtualenv.

  • Generate docs for ReadTheDocs.

  • Localize user messages using Babel.

  • Easily install to shared or isolated virtualenvs.

• GitHub Actions linting, testing, and coverage upload.

Most of the files are designed to be hard linked from the derived projects themselves, as they won’t need to be customized (such as Makefile).

• Then when the boilerplate changes, you can just commit the changes in the derived project, call them “dependency updates” or something, and not have to worry about merging changes manually (and running meld or something).