From 1cf9a5e6c4c930772ca303904e604644ce35bf25 Mon Sep 17 00:00:00 2001 From: Mathew Sir Guest the best Date: Sat, 30 May 2026 22:49:30 -0600 Subject: [PATCH] docs: document supported Python versions and the test matrix Co-Authored-By: Claude Opus 4.8 (1M context) --- CLAUDE.md | 8 +++++++- README.md | 10 ++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CLAUDE.md b/CLAUDE.md index 0fe7660..098db49 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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 diff --git a/README.md b/README.md index 290313e..861ca2a 100644 --- a/README.md +++ b/README.md @@ -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 ======