docs: clarify sdist/source-build requirements in the README - #46
Merged
Merged
Conversation
State the build deps accurately now that the comment-line dispatcher landed and 3.14 wheels + an sdist are published: - a C compiler only (Fortran fextxyz is optional/off by default); - libcleri is bundled (submodule in the repo, vendored into the sdist) and always built from source — no longer an external dependency; - PCRE2 is the one external native library: a system copy via pkg-config, else the build downloads+compiles it from the bundled meson wrap (needs network) — it is NOT vendored; - NumPy is a build-time dep (C-API headers for the fast read path; falls back to ctypes without it); meson/ninja/pyleri are installed automatically by pip. Also note wheels cover CPython 3.10-3.14 and that an sdist is published. Co-Authored-By: Claude Opus 4.8 (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
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.
What
Make the README's source-build requirements accurate, now that the comment-line dispatcher landed and v0.4.4 ships CPython 3.10–3.14 wheels + an sdist.
Two paragraphs in the install section:
fextxyzis optional/off by default); libcleri is bundled (submodule in the repo, vendored into the sdist) and always built from source — no longer an external dep; PCRE2 is the one external native library — system via pkg-config, else downloaded+compiled from the bundled meson wrap (needs network), not vendored; NumPy is a build-time dep (C-API headers for the fast read path); meson/ninja/pyleri are auto-installed by pip.Why
Verified against the published v0.4.4 sdist: a clean
uv pip install --no-binary extxyzbuilds from source, but it links a system PCRE2 (/opt/homebrew/opt/pcre2/...) — the sdist ships onlysubprojects/pcre2.wrap(a download pointer), so PCRE2 must be present or downloadable, while libcleri is genuinely bundled. The old wording ("requires the PCRE2 and libcleri libraries") blurred that distinction.Docs-only.
🤖 Generated with Claude Code