-
Notifications
You must be signed in to change notification settings - Fork 2
Docs use dynamic python version from pypi #69
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR modernizes the Python version documentation by replacing a static badge with a dynamic PyPI-sourced badge and adding explicit version classifiers to project metadata.
- Updated README.md to use a dynamic shields.io badge that automatically reflects supported Python versions from PyPI
- Added Python version classifiers (3, 3.11, 3.12, 3.13) to pyproject.toml, consistent with the existing
requires-python = ">3.10, <3.14"constraint
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Replaced static Python version badge with dynamic PyPI-based badge |
| pyproject.toml | Added explicit Python version classifiers for 3.11, 3.12, and 3.13 |
I've completed my review of this pull request. The changes are well-implemented and consistent:
-
README.md: The new badge URL
https://img.shields.io/pypi/pyversions/lanfactoryis the correct format for shields.io to dynamically display Python versions from PyPI metadata. -
pyproject.toml: The added classifiers (Python 3, 3.11, 3.12, 3.13) correctly match the existing
requires-python = ">3.10, <3.14"constraint, which supports Python 3.11, 3.12, and 3.13.
The changes align perfectly with the PR description and achieve the stated goal of making the Python version documentation more maintainable by sourcing it from PyPI rather than requiring manual updates.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
|
Thanks @cpaniaguam this is great. Failed on that before. |
AlexanderFengler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
@AlexanderFengler there is a corresponding PR for ssms and hssm already has this. |
This pull request updates the documentation and project metadata to more accurately reflect supported Python versions.
Documentation update:
README.mdto dynamically show all supported versions via PyPI, instead of listing specific versions.Project metadata:
3,3.11,3.12,3.13) topyproject.tomlfor clearer compatibility information.