docs: document supported Python versions and the test matrix

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Mathew Sir Guest the best 2026-05-30 22:49:30 -06:00
parent d1420dccda
commit 1cf9a5e6c4
2 changed files with 17 additions and 1 deletions

@ -24,9 +24,15 @@ flake8 smileyface/
# Run pre-commit hooks manually
pre-commit run --all-files
# Run the smoke-test suite on the current interpreter
uv run --with . --with pytest pytest -v
# Run the full Python version matrix (3.8-3.13)
uv run --with nox nox -s tests
```
There is no test suite.
Smoke tests live in `tests/` (import, CLI `--help`, and settings checks) and run across the supported Python 3.8-3.13 matrix via `nox`.
## Code Style

@ -15,6 +15,16 @@ Activate your desired python environment, then:
poetry install
Supported Python Versions
==========================
SmileyFace is tested against CPython 3.8 3.13. The supported range is
enforced by a smoke-test matrix.
To run the matrix locally (requires [uv](https://docs.astral.sh/uv/)):
uv python install 3.8 3.9 3.10 3.11 3.12 3.13
uv run --with nox nox -s tests
Usage
======