Skip to content

Document local test setup and pytest commands #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yuefdev wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document local test setup and pytest commands #435

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b73976d
Document local test setup and pytest commands
yuefdev Oct 3, 2026
3c2ca4e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 3, 2026
f2f139c
docs: use tox for local testing instructions
yuefdev Oct 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Contributing

## Running tests

Use [tox](https://tox.wiki/) from the repository root. It creates an isolated
environment and installs the project and its test dependencies:

```sh
python -m pip install tox
tox -e py
```

Pass pytest arguments after `--` to run a single file or tests matching a name:

```sh
tox -e py -- tests/test_number.py
tox -e py -- tests/test_number.py -k intcomma
```

Some localisation tests are skipped when compiled `.mo` translation files are missing.
Generate them with `scripts/generate-translation-binaries.sh`, which requires Bash and
GNU gettext's `msgfmt`. Translation-update tests also require `xgettext` and `msgmerge`.
Use `tox -e py -- -rs` to see skip reasons.

CI generates translation binaries and runs the
[configured tox environments](../tox.ini). See the [test workflow](workflows/test.yml)
for supported Python versions and platforms.

## Linting

Linting is run on the CI using [prek](https://prek.j178.dev//), and can be run locally:
Expand Down