Fix the Python wheel build (CI has been red since 2025-12) - #7
Merged
Conversation
`build-python` has failed on every CI run since 2025-12 with:
OSError: Readme file does not exist: README.md
python/README.md was a symlink to ../README.md. `uv build` builds the wheel
from the source distribution, and inside that tarball the link dangles — its
target sits outside the packaged tree — so hatchling cannot read the file that
`project.readme` points at.
Replaced with a real, deliberately short README that covers install and
configuration and links to the repository for the rest, so the two copies have
little room to drift. Verified locally: both sdist and wheel now build, and the
sdist carries the file rather than a link.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LVnEdm6smNC5ZJzghc7WRY
Merged
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.
Every CI run on
mainsince 2025-12 has failed onbuild-python:Cause
python/README.mdwas a symlink to../README.md.uv buildbuilds the wheel from the source distribution, and inside that tarball the link dangles — its target lives outside the packaged tree — so hatchling cannot read the fileproject.readmepoints at.The tell is that the sdist listing contains
README.mdand the build still fails: the entry is a link, not a file.Fix
Replaced it with a real file: a short Python-specific README covering install and configuration, linking to the repository for the full tool reference. Kept deliberately short so the two copies have little room to drift.
Verification
Reproduced the failure locally, then confirmed the fix:
Found while working on #4 — the red job made it impossible to tell whether that PR was green. Worth merging first.
🤖 Generated with Claude Code
https://claude.ai/code/session_01LVnEdm6smNC5ZJzghc7WRY