docs: replace stale Python-versions line with a pyversions badge#234
Open
midhunxavier wants to merge 1 commit into
Open
docs: replace stale Python-versions line with a pyversions badge#234midhunxavier wants to merge 1 commit into
midhunxavier wants to merge 1 commit into
Conversation
The README hardcoded "Supported Pythons: 3.7 to 3.12", but the package requires `>=3.8.0,<3.13` (setup.py) and CI only tests 3.8-3.12, so 3.7 was incorrect. Replace the manually-maintained line with the dynamic shields.io `pyversions` badge in the top badge row, matching other Farama projects so it stays correct across releases. The `stable-retro` PyPI package currently ships no Python trove classifiers, which the `pyversions` badge reads, so also add the `Programming Language :: Python :: 3.8`..`3.12` classifiers to setup.py. The badge will resolve to 3.8-3.12 once a release including these classifiers is published. Fixes Farama-Foundation#227 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Description
The README hardcoded
Supported Pythons: 3.7 to 3.12, but the package requires>=3.8.0,<3.13(setup.py) and CI only tests3.8–3.12— so3.7was incorrect.This replaces the manually-maintained line with the dynamic shields.io
pyversionsbadge in the README's top badge row (matching other Farama projects), so the supported-versions info stays correct across future releases without manual edits. This follows the approach suggested by the issue reporter.Changes
[](https://pypi.org/project/stable-retro/)to the top badge row, and remove the staleSupported Pythons: 3.7 to 3.12line.Programming Language :: Python :: 3.8…3.12trove classifiers. Thepyversionsbadge reads these from PyPI, andstable-retrocurrently ships none.Note on the badge
The
pyversionsbadge resolves from PyPI trove classifiers, not fromrequires-python. The latest publishedstable-retrorelease has no Python classifiers, so the badge will renderpython | missinguntil a release including these classifiers is published. After the next release it will show3.8 | 3.9 | 3.10 | 3.11 | 3.12.Verification
pre-commit run --files README.md setup.py— all hooks pass (black, isort, flake8, pyupgrade, add-trailing-comma).autopep8 --diff setup.py— no changes (PEP8-clean, perscripts/lint.sh).setup.pyparses; the classifiers matchpython_requiresand the CI test matrix.Fixes #227