Management commands¤

Setup all virtual environments (install dependencies).

make setup

The setup command installs all the Python dependencies required to work on the project. Virtual environments and dependencies are managed by uv. Development dependencies are listed in the devdeps.txt file.

The command will create a virtual environment in the .venv folder, as well as one virtual environment per supported Python version in the .venvs/3.x folders. Supported Python versions are listed in the scripts/make file, and can be overridden by setting the PYTHON_VERSIONS environment variable.

If you cloned the repository on the same file-system as uv's cache, everything will be hard linked from the cache, so don't worry about wasting disk space.

Once dependencies are installed, try running make or make help again, to show additional tasks.

$ make
Available commands
  help                  Print this help. Add task name to print help.
  setup                 Setup all virtual environments (install dependencies).
  run                   Run a command in the default virtual environment.
  multirun              Run a command for all configured Python versions.
  allrun                Run a command in all virtual environments.
  3.x                   Run a command in the virtual environment for Python 3.x.
  clean                 Delete build artifacts and cache files.
  vscode                Configure VSCode to work on this project.

Available tasks
  build                 Build source and wheel distributions.
  changelog             Update the changelog in-place with latest commits.
  check                 Check it all!
  check-api             Check for API breaking changes.
  check-docs            Check if the documentation builds correctly.
  check-quality         Check the code quality.
  check-types           Check that the code is correctly typed.
  coverage              Report coverage as text and HTML.
  docs                  Serve the documentation (localhost:8000).
  docs-deploy           Deploy the documentation to GitHub pages.
  format                Run formatting tools on the code.
  fuzz                  Fuzz Griffe against generated Python code.
  publish               Publish source and wheel distributions to PyPI.
  release               Release a new version of the project.
  test                  Run the test suite.

These tasks are written using duty (a task runner), and located in the duties.py module in the repository root.

Some of these tasks will run in the default virtual environment (.venv), while others will run in all the supported Python version environments (.venvs/3.x).

Print this help. Add task name to print help.

make help [TASK]

When the Python dependencies are not installed, this command just print the available commands. When the Python dependencies are installed, duty is available so the command can also print the available tasks.

If you add a task name after the command, it will print help for this specific task.

Run a command in the default virtual environment.

make run <CMD> [ARG...]

This command runs an arbitrary command inside the default virtual environment (.venv). It is especially useful to start a Python interpreter without having to first activate the virtual environment: make run python.

Run a command for all configured Python versions.

make multirun <CMD> [ARG...]

This command runs an arbitrary command inside the environments for all supported Python versions. It is especially useful for running tests.

Run a command in all virtual environments.

make multirun <CMD> [ARG...]

This command runs an arbitrary command inside the default environment, as well as the environments for all supported Python versions.

This command is especially useful to install, remove or update dependencies in all environments at once. For example, if you want to install a dependency in editable mode, from a local source:

make allrun uv pip install -e ../other-project

Run a command in the virtual environment for Python 3.x.

make 3.x <CMD> [ARG...]

This command runs an arbitrary command inside the environment of the selected Python version. It can be useful if you want to run a task that usually runs in the default environment with a different Python version.

Delete build artifacts and cache files.

make clean

This command simply deletes build artifacts and cache files and folders such as build/, .cache/, etc.. The virtual environments (.venv and .venvs/*) are not removed by this command.

Configure VSCode to work on this project.

make vscode

This command configures the VSCode editor by copying the following files into the .vscode directory:

• launch.json, for run configurations (to run debug sessions)
• settings.json, for various editor settings like linting tools and their configuration
• tasks.json, for running tasks directly from VSCode's interface

Build source and wheel distributions.

make build

Build distributions of your project for the current version. The build task uses the build tool to build .tar.gz (Gzipped sources archive) and .whl (wheel) distributions of your project in the dist directory.

Update the changelog in-place with latest commits.

make changelog [bump=VERSION]

Update the changelog in-place. The changelog task uses git-changelog to read Git commits and parse their messages to infer the new version based on our commit message convention.

The new version will be based on the types of the latest commits, unless a specific version is provided with the bump parameter.

If the group of commits contains only bug fixes (fix:) and/or commits that are not interesting for users (chore:, style:, etc.), the changelog will gain a new patch entry. It means that the new suggested version will be a patch bump of the previous one: 0.1.1 becomes 0.1.2.

If the group of commits contains at least one feature (feat:), the changelog will gain a new minor entry. It means that the new suggested version will be a minor bump of the previous one: 0.1.1 becomes 0.2.0.

If there is, in the group of commits, a commit whose body contains something like Breaking change, the changelog will gain a new major entry, unless the version is still an "alpha" version (starting with 0), in which case it gains a minor entry. It means that the new suggested version will be a major bump of the previous one: 1.2.1 becomes 2.0.0, but 0.2.1 is only bumped up to 0.3.0. Moving from "alpha" status to "beta" or "stable" status is a choice left to the developers, when they consider the package is ready for it.

The configuration for git-changelog is located at config/git-changelog.toml.

Parameters:

• bump (str, default: '' ) –

  Bump option passed to git-changelog.

Check it all!

make check

Composite command to run all the check commands:

• check-quality, to check the code quality on all Python versions
• check-types, to type-check the code on all Python versions
• check-docs, to check the docs on all Python versions
• check-api, to check for API breaking changes

Check for API breaking changes.

make check-api

Compare the current code to the latest version (Git tag) using Griffe, to search for API breaking changes since latest version. It is set to allow failures, and is more about providing information than preventing CI to pass.

Parameters:

• *cli_args (str, default: () ) –

  Additional Griffe CLI arguments.

Check if the documentation builds correctly.

make check-docs

Build the docs with MkDocs in strict mode.

The configuration for MkDocs is located at mkdocs.yml.

This task builds the documentation with strict behavior: any warning will be considered an error and the command will fail. The warnings/errors can be about incorrect docstring format, or invalid cross-references.

Check the code quality.

make check-quality

Check the code quality using Ruff.

The configuration for Ruff is located at config/ruff.toml. In this file, you can deactivate rules or activate others to customize your analysis. Rule identifiers always start with one or more capital letters, like D, S or BLK, then followed by a number.

You can ignore a rule on a specific code line by appending a noqa comment ("no quality analysis/assurance"):

print("a code line that triggers a Ruff warning")  # noqa: ID

...where ID is the identifier of the rule you want to ignore for this line.

import subprocess

$ make check-quality
✗ Checking code quality (1)
> ruff check --config=config/ruff.toml src/ tests/ scripts/
src/your_package/module.py:2:1: S404 Consider possible security implications associated with subprocess module.

import subprocess  # noqa: S404

$ make check-quality
✓ Checking code quality

You can disable a warning globally by adding its ID into the list in config/ruff.toml.

You can also disable warnings per file, like so:

[per-file-ignores]
"src/your_package/your_module.py" = [
    "T201",  # Print statement
]

Check that the code is correctly typed.

make check-types

Run type-checking on the code with Mypy.

The configuration for Mypy is located at config/mypy.ini.

If you cannot or don't know how to fix a typing error in your code, as a last resort you can ignore this specific error with a comment:

print("a code line that triggers a Mypy warning")  # type: ignore[ID]

...where ID is the name of the warning.

result = data_dict.get(key, None).value

$ make check-types
✗ Checking types (1)
> mypy --config-file=config/mypy.ini src/ tests/ scripts/
src/your_package/module.py:2:1: Item "None" of "Data | None" has no attribute "value" [union-attr]

result = data_dict.get(key, None).value  # type: ignore[union-attr]

$ make check-types
✓ Checking types

Report coverage as text and HTML.

make coverage

Combine coverage data from multiple test runs with Coverage.py, then generate an HTML report into the htmlcov directory, and print a text report in the console.

Serve the documentation (localhost:8000).

make docs

This task uses MkDocs to serve the documentation locally.

Parameters:

• *cli_args (str, default: () ) –

  Additional MkDocs CLI arguments.

• host (str, default: '127.0.0.1' ) –

  The host to serve the docs from.

• port (int, default: 8000 ) –

  The port to serve the docs on.

Deploy the documentation to GitHub pages.

make docs-deploy

Use MkDocs to build and deploy the documentation to GitHub pages.

Parameters:

• force (bool, default: False ) –

  Whether to force deployment, even from non-Insiders version.

Run formatting tools on the code.

make format

Format the code with Ruff. This command will also automatically fix some coding issues when possible.

Fuzz Griffe against generated Python code.

Parameters:

• ctx (Context) –

  The context instance (passed automatically).

• size (int, default: 20 ) –

  The size of the case set (number of cases to test).

• seeds (Seeds, default: Seeds() ) –

  Seeds to test or exclude.

• min_seed (int, default: 0 ) –

  Minimum value for the seeds range.

• max_seed (int, default: 1000000 ) –

  Maximum value for the seeds range.

Publish source and wheel distributions to PyPI.

make publish

Publish the source and wheel distributions of your project to PyPI using Twine.

Release a new version of the project.

make release [version=VERSION]

This task will:

• Stage changes to pyproject.toml and CHANGELOG.md
• Commit the changes with a message like chore: Prepare release 1.0.0
• Tag the commit with the new version number
• Push the commit and the tag to the remote repository
• Build source and wheel distributions
• Publish the distributions to PyPI
• Deploy the documentation to GitHub pages

Parameters:

• version (str, default: '' ) –

  The new version number to use. If not provided, you will be prompted for it.

Run the test suite.

make test [match=EXPR]

Run the test suite with Pytest and plugins. Code source coverage is computed thanks to coveragepy.

Parameters:

• *cli_args (str, default: () ) –

  Additional Pytest CLI arguments.

• match (str, default: '' ) –

  A pytest expression to filter selected tests.