CONTRIBUTING.md

Contributing to Panvoy

Setting up Panvoy for development

To set up Panvoy, you need the Python project management tool uv.

Installing uv

To install uv, see its installation instructions.

To verify uv is working, run:

uv

Development scripts and tasks

To see a list of available tasks, run: uv run poe tasks

Running Panvoy

To execute Panvoy, run:

uv run poe cli

Running the tests

To execute the tests, run:

uv run poe tests

To execute a single test, run e. g.:

uv run poe tests -vv tests/test_api.py::test_parse_jrpn_url

Running the linter

To execute the linter, run:

uv run poe linter

Running the code formatting style check

To check the code base for formatting style violations that are not covered by the linter, run:

uv run poe formatcheck

Running the static type check

To execute the static type check, run:

uv run poe typecheck

Running the entire CI pipeline locally

If you have act installed and a Docker daemon active, run:

act

Generating project documentation

To generate project documentation (HTML and man page), run:

uv run poe doc

To open the generated HTML documentation in your browser, run:

uv run poe html

To open the generated manual page in your terminal, run:

uv run poe man

Maintenance

Refreshing dependencies

If you get errors after a Git pull, refresh your dependencies:

uv sync

Checking Panvoy’s dependencies for compatible updates

To check Panvoy’s dependencies for compatible updates, run:

uv lock -U --dry-run

Updating requirements file for Read the Docs

To update the doc/requirements.txt file for Read the Docs, run:

uv export --only-group doc --output-file doc/requirements.txt