bulletproof-python

A magic-free, understandable python project template using tox, ruff, pytest and pip-tools. This template requires you to manage your own virtual environment, but the configuration is explicit and easy to understand.

This is a great starting point, but it is just that. There are a great many best practices with respect to packaging and distribution that are not covered here, and for which I refer you to Seth Michael Larson's secure-python-package-template.

Background

I owe a debt of gratitude to Claudio Jolowicz for introducing me to modern python tooling. His Hypermodern Python template and associated blog series are a great resource.

The Hypermodern system is built around nox and poetry.

• nox is similar in spirit to tox but uses python scripts instead of configuration files.
• It's very powerful, but since I'm not particularly clever, I find the hypermodern stack difficult to understand.

I decided to throw together a simple template that uses tox and pip-tools. The template uses:

• pytest and coverage.py for testing,
• black for formatting,
• ruff for linting,
• pip-tools for managing dependencies, and
• tox for coordinating it all.

It strives to be clean, simple and hard to break, albeit with a little extra elbow grease involved relative to more batteries-included tools like poetry.

Quick-start

1. Install tox using pipx
2. Click 'Use this template' to create a new repository and clone it
3. Create and activate a virtual environment
4. Install the dependencies with python -m pip install --upgrade pip setuptools wheel pip-tools followed by pip-sync
5. Install the first-party package in editable mode: pip install -e .
6. Install the pre-commit hooks: pre-commit install
7. Run the test suite with tox: tox
8. Replace the name bulletproof_python/bulletproof-python with your project name
9. Update project metadata in pyproject.toml and README.md
10. Write some code and lint it: tox -e fix.

Detailed Usage

1. Install tox using pipx

Tox is a tool for automating testing and development tasks in isolated environments. You can use pipx, a package runner for Python applications, to install tox. The command is simply:

pipx install tox

2. Create a New Repository and Clone it

The 'Use this template' button on GitHub allows you to create a new repository from a template repository like this one. After creating your new repository, clone it onto your local machine using:

git clone https://github.com/your_username/your_repository.git

3. Create and Activate a Virtual Environment

Virtual environments in Python isolate project dependencies, ensuring different projects don't interfere with each other. To create and activate a new virtual environment:

python -m venv .venv
source .venv/bin/activate

4. Install the Dependencies

The requirements.txt file lists the Python dependencies for your project. Using pip-tools, we can pin the exact version of each dependency to ensure reproducible builds.

Install the core python dependencies then install the project dependencies using pip-tools:

python -m pip install --upgrade pip setuptools wheel pip-tools
pip-sync

You can optionally use pip-tools to update all dependencies before running pip-sync. This isn't strictly necessary as I keep this repository more-or-less up to date, and dependabot will submit pull requests for out of date packages automatically.

pip-compile --all-extras --resolver=backtracking --upgrade pyproject.toml

Note: You can always reference the command to pin dependencies in a comment at the top of requirements.txt.

5. Install the First-Party Package in Editable Mode

The -e option allows pip to install the package in editable mode. This means changes to the source code will immediately affect the package without needing to reinstall it:

python -m pip install -e .

6. Install the Pre-commit Hooks

Pre-commit is a framework for managing git pre-commit hooks. These checks are run before your changes are committed to ensure code quality. To install pre-commit hooks:

pre-commit install

You can also update the hook versions:

pre-commit autoupdate

7. Run the Test Suite with tox

Now you can run the project's test suite using the previously installed tox tool:

tox

By default, this will create environments for py310, py311 and py312. This assumes all versions of python are available on your system. Take a look at pyenv to make this easy.

You can add additional python versions to test against by modifying tox.ini and the corresponding github-action workflow.

8. Replace the Project Name

Now replace the placeholder project name bulletproof_python/bulletproof-python with the name of your actual project throughout the project files.

9. Update Project Metadata

Update the project metadata in both pyproject.toml and README.md to match your project's details.

10. Write Code and Lint it

Now write your code! After that, you can run linting checks and auto-fix issues using tox:

tox -e fix

Take a look at tox.ini for a reference on using the various tools directly from the command line. During development, you don't always need to execute through tox's isolated environments.