Contributing to literalizer-cli

Contributions to this repository must pass tests and linting.

CI is the canonical source of truth.

Install contribution dependencies

Install Python dependencies in a virtual environment.

$ pip install --editable '.[dev]'

Install pre-commit hooks:

$ prek install

Linting

Run lint tools either by committing, or with:

$ prek run --all-files --hook-stage pre-commit --verbose
$ prek run --all-files --hook-stage pre-push --verbose
$ prek run --all-files --hook-stage manual --verbose

Running tests

Run pytest:

$ pytest

Documentation

Run the following commands to build and view documentation locally:

$ uv run --extra=dev sphinx-build -M html docs/source docs/build -W
$ python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'

Continuous integration

Tests are run on GitHub Actions. The configuration for this is in .github/workflows/.

Performing a release

See Release process.