Development¶

This page covers everything needed to work on this project locally: installing dependencies, linting, and running the test suite.

Project setup¶

Install dependencies and vendor htmx:

uv sync
npm install
./scripts/setup-vendor-htmx.sh   # clones htmx source into vendor/htmx, required by the tests

Linting¶

We use prek for linting and formatting.

To install the git hooks (so they run automatically on each commit):

prek install

To run all hooks manually (auto-fixes most issues in place):

prek -a

Testing¶

The test suite includes some hypothesis property-based tests that crosscheck the behavior of this client against a real browser in many different scenarios. This part of the tests can be rather slow so it's disabled by default.

To run all tests but the crosscheck:

pytest

To run only the hypothesis crosscheck tests:

pytest -m "cross"

To run the full suite, including the crosscheck tests:

pytest -m ""

Tests can run in parallel by adding the pytest option -n auto.