Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (53 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

80 lines (53 loc) · 1.06 KB

Contributing

Thanks for contributing to pdfrest.

Development setup

  1. Install project tooling:
uv sync --group dev
  1. (Recommended) install git hooks:
uv run pre-commit install
  1. Verify package import/version:
uv run python -c "import pdfrest; print(pdfrest.__version__)"

Code quality checks

Run these before opening a PR:

uv run ruff format .
uv run ruff check .
uv run basedpyright

Tests

Quick local run:

uv run pytest -n auto --maxschedchunk 2

Full interpreter matrix with coverage artifacts (coverage/py<version>/):

uvx nox -s tests

Class/function coverage gate for client classes:

uvx nox -s class-coverage

To reuse existing coverage JSON without rerunning tests:

uvx nox -s class-coverage -- --no-tests

Examples

Run all examples:

uvx nox -s examples

Run one example:

uv run nox -s run-example -- examples/delete/delete_example.py

Docs preview (optional)

uv run mkdocs serve
uv run mkdocs build --strict