docs: README usage/install section; ci: test full Python version matrix - #22
Merged
Merged
Conversation
ci: test across the full supported Python version matrix README lacked installation instructions, a usage example, and a list of the public Graphik methods -- the first thing a PyPI visitor sees. Also pointed the Projects link at the current Stephenson-Software/graphik location instead of the pre-transfer Preponderous-Software/Graphik path. The test workflow only ran on Python 3.13 while pyproject.toml claimed support back to 3.8. Added a matrix covering every pygame-wheel-backed version (3.9-3.13) and bumped requires-python to >=3.9 to match, since 3.8 is EOL and untested. Closes #19 Closes #20 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric:
Note: this PR touches |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pip install graphik) and a Usage section documenting all publicGraphikmethods and color constants to README.md — it doubles as the PyPI long description and previously had no install/usage info.Preponderous-Software/Graphikwiki path, to the currentStephenson-Software/graphiklocation.3.9-3.13), covering every version pygame ships a prebuilt wheel for, so the declaredrequires-pythonrange is actually exercised.requires-pythonfrom>=3.8to>=3.9inpyproject.tomlsince 3.8 is EOL (Oct 2024) and isn't tested -- keeps the declared floor and the tested floor in agreement per issue ci: test workflow verifies only Python 3.13 while pyproject claims >=3.8 support #20's acceptance criteria.Test plan
python3 -m py_compile src/main/python/preponderous/graphik/graphik.pypython3 -c "import sys; sys.path.insert(0,'src/main/python'); import preponderous.graphik as g; print(g.__version__)"->0.2.0python3 -m pytest -q-> 19 passed (conftest.py already forcesSDL_VIDEODRIVER/SDL_AUDIODRIVER=dummy, so this runs headless without extra env vars)Note: also closed #5 (packaging/distribution) separately during this cycle -- it was fully resolved by prior merged PRs (pyproject.toml, single version source, PyPI publish workflow) with only out-of-scope consumer-migration follow-up remaining.
Closes #19
Closes #20