docs: install from PyPI, and fix the broken image on pypi.org - #57
Merged
Conversation
Two fixes, both consequences of README.md doubling as the PyPI long_description. **Install instructions.** All four packages are now on PyPI, so the git+https incantations are no longer the primary path. `uv add nooa` and `pip install nooa` replace them, with the sibling packages documented both by name and as extras (`nooa[cli]`). The from-source instructions are kept in a collapsed section for people tracking main or pinning a tag. eval_pipeline stays a git install — it is not published. **Broken image and links on pypi.org.** The header used repo-relative paths (`assets/…svg`), and five doc links were relative too (AGENTS.md, CONTRIBUTING.md, LICENSE, THIRD_PARTY_NOTICES.md, examples/README.md). PyPI renders the long_description standalone, with no repo alongside it, so all of them 404 there — that is the broken image on https://pypi.org/project/nooa/. GitHub resolves relative and absolute alike, so absolute URLs work in both places. The dark/light <picture> switching still works on GitHub: only the URLs changed, not the markup. Note this cannot fix the 0.0.7 page. The long_description is baked into the uploaded artifact and PyPI does not accept re-uploads of an existing version, so the corrected README first appears on the next release. Verified: all 7 new URLs return 200; the built wheel's METADATA contains no `assets/` relative paths and 3 absolute ones; twine check passes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
alessiodevoto
approved these changes
Jul 30, 2026
alessiodevoto
left a comment
alessiodevoto
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for fixing this!
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
2 participants
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.
Two fixes, both consequences of
README.mddoubling as the PyPIlong_description.1. Install from PyPI
All four packages went live with
v0.0.7, sogit+https://…is no longer the primary install path.The sibling packages are documented both by name and as extras, with a table of what each adds. From-source instructions are kept in a collapsed
<details>for anyone trackingmainor pinning a tag.eval_pipelinestays a git install — it isn't published.2. Broken image on pypi.org
The header used repo-relative paths:
PyPI renders the
long_descriptionstandalone, with no repo alongside it, soassets/…404s. That's the broken image right below "Project description" on https://pypi.org/project/nooa/.Five doc links had the same problem:
AGENTS.md,CONTRIBUTING.md,LICENSE,THIRD_PARTY_NOTICES.md,examples/README.md.All now absolute. GitHub resolves relative and absolute alike, so this works in both places, and the dark/light
<picture>switching is unaffected — only the URLs changed, not the markup.The
long_descriptionis baked into the uploaded artifact, and PyPI does not accept re-uploads of an existing version. The corrected README first appears on the next release. The 0.0.7 page will keep its broken image permanently.Verified
200METADATAcontains 0assets/relative paths and 3 absolute onestwine checkpasses on wheel + sdist🤖 Generated with Claude Code