fix(python): lead the README with the PyPI install #327

Merged

jqueuniet merged 1 commit from fix/pypi-readme-install into main

2026-09-05 10:20:38 +02:00

jqueuniet commented

2026-09-05 09:00:12 +02:00

Owner

bindings/python/README.md is the long description rendered on the PyPI
project page, and it opened with:

pip install ./bindings/python

That path only exists for someone who has already cloned the workspace, and it
needs a Rust toolchain on PATH. A reader arriving at the PyPI page was being
told to do the hard thing.

pip install dm2-tools leads now, with the wheel platforms (manylinux 2.28 and
win_amd64) and the 3.11 floor stated next to it. The from-a-checkout path stays,
reframed as what it actually is: the route for macOS and other architectures,
which have neither a wheel nor an sdist to fall back on. The repository link is
spelled out, since a PyPI reader has no relative path to follow.

Note this cannot fix the page for 0.2.1 — PyPI renders the description of each
uploaded version and it cannot be edited in place, so the corrected text
appears with the next release.

`bindings/python/README.md` is the long description rendered on the PyPI project page, and it opened with: ```bash pip install ./bindings/python ``` That path only exists for someone who has already cloned the workspace, and it needs a Rust toolchain on `PATH`. A reader arriving at the PyPI page was being told to do the hard thing. `pip install dm2-tools` leads now, with the wheel platforms (manylinux 2.28 and win_amd64) and the 3.11 floor stated next to it. The from-a-checkout path stays, reframed as what it actually is: the route for macOS and other architectures, which have neither a wheel nor an sdist to fall back on. The repository link is spelled out, since a PyPI reader has no relative path to follow. Note this cannot fix the page for 0.2.1 — PyPI renders the description of each uploaded version and it cannot be edited in place, so the corrected text appears with the next release.

jqueuniet added 1 commit

2026-09-05 09:00:12 +02:00

fix(python): lead the README with the PyPI install

CI / msrv (1.90) (pull_request) Successful in 42s

Details

CI / audit (pull_request) Successful in 24s

Details

CI / stable (pull_request) Successful in 1m37s

Details

CI / python bindings (3.11) (pull_request) Successful in 39s

Details

CI / stable (push) Successful in 1m40s

Details

CI / python bindings (3.11) (push) Successful in 41s

Details

CI / msrv (1.90) (push) Successful in 45s

Details

CI / audit (push) Successful in 21s

Details

2e3e0a230a

The README is the package description rendered on PyPI, where it opened with
`pip install ./bindings/python` — a path that only exists for someone who has
already cloned the workspace, and which needs a Rust toolchain. A reader
arriving from the project page was being told to do the hard thing.

`pip install dm2-tools` leads now, with the wheel platforms and the Python
floor stated next to it. The from-a-checkout path stays, reframed as what it
actually is: the route for macOS and other architectures, which have no wheel
and no sdist to fall back on.

jqueuniet merged commit 2e3e0a230a into main

2026-09-05 10:20:38 +02:00

jqueuniet deleted branch fix/pypi-readme-install

2026-09-05 10:20:38 +02:00

No reviewers

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

jqueuniet/dm2-tools!327

No description provided.

Rows
Columns