Repository navigation
docs: show the PyPI badges in the README - #11
Merged
Merged
Conversation
The README kept the PyPI version and downloads badges inside an HTML comment with a note to uncomment them once the package was published. The package has been on PyPI since 0.1.0, so the badges never showed and the note was out of date. The badges now sit with the License and Python badges, and the note is gone. A new test, tests/test_readme.py, fails if the note comes back or if either PyPI badge ends up inside an HTML comment. Ledger: B253 Co-Authored-By: Claude Opus 5.5 <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.
The README hid its PyPI version and downloads badges inside an HTML comment that said to uncomment them once the package was published. The package has been on PyPI since 0.1.0 (the current release is 0.3.1), so this change shows both badges next to the License and Python badges and removes the outdated note.
Fixes
README.md, so the two existing badges render on the same line as the License and Python badges.tests/test_readme.py::test_readme_does_not_say_package_is_unpublished,tests/test_readme.py::test_readme_shows_pypi_badgesNot fixed here
CHANGELOG.mdstill say the PyPI badges are commented out until the package is published. Those entries describe what those releases contained, so they stay as written.How it was tested
main, where the badges are inside a comment and the note is present, and pass on this branch.test_readme_shows_pypi_badgesremoves HTML comments before it looks for the badge URLs, so a badge that is present but commented out still fails it.main, plus the 2 new tests).ruff check .passes.python -m buildproduces the sdist and wheel.🤖 Generated with Claude Code