Repository navigation
fix: the banner could not render on PyPI, for two separate reasons - #52
Merged
Merged
Conversation
Both were invisible locally and on GitHub, where the README renders fine. The src was `assets/banner.svg`, a RELATIVE path. PyPI renders a long_description with no repository context, so it resolves to nothing. PyPI proxies images through camo, which does not serve SVG. So even an absolute URL ending in .svg is a broken image. Now an absolute raw.githubusercontent URL pointing at a PNG rendered from the SVG, which stays the source. tests/test_layering.py asserts both conditions for every image in the README, plus that the file actually exists at the path the URL claims — a 404 from raw.githubusercontent looks exactly like a broken renderer. The banner's own tagline was stale too: "benchmark-driven admission control layer for LLM inference", which is what the project was before it became a standard for policies. It now matches the package summary. Version 0.0.2, because a published long_description cannot be edited — PyPI renders it from the uploaded distribution's metadata, so fixing the page requires a release. 179 passed, lint clean, both artifacts pass twine check --strict. Co-Authored-By: Claude Opus 5 (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
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.
Both invisible locally and on GitHub, where the README renders fine.
assets/banner.svg— a relative path. PyPI renders along_descriptionwith no repository context, so it resolves to nothing.svgis a broken imageFixed to an absolute
raw.githubusercontent.comURL pointing at a PNG rendered from the SVG, which stays the source.Tested, so it cannot regress
Plus a check that the file actually exists at the path the URL claims — a 404 from
raw.githubusercontentlooks exactly like a broken renderer.I verified the fix through
readme_renderer, which is the library PyPI itself uses: one image survives, no.svgreferences remain.The banner was also stale
Its tagline read "benchmark-driven admission control layer for LLM inference" — what the project was before it became a standard for policies. Now matches the package summary.
Why 0.0.2
A published
long_descriptioncannot be edited. PyPI renders it from the uploaded distribution's metadata, so fixing the page requires a release. Tagv0.0.2after merge.179 passed, lint clean, both artifacts pass
twine check --strict.