F21.4 — Consumers install from PyPI
| State | Closed |
| Parent | E21 |
| Iteration | Release 7 |
| Start Date | 2026-10-28 |
| Closed Date | 2026-10-28 |
| Predecessors | F21.3 |
| Source | Owner request, 2026-10-26 |
Stories: 1 Closed
| Story | State | Depends on |
|---|---|---|
| S21.4.1 — Install docs describe PyPI | Closed | — |
Outcome: in Release 7 every install page (the root README, each package's README and installation guide, the consuming guide and the release runbook) was rewritten to install from PyPI by name and range, with the direct-URL form kept as the alternative. Current usage is in the consuming guide and the release runbook.
Design
The pages were written in the release that first published to PyPI, so they were true when it shipped. The guide keeps Pin one exact version and Fall back to a direct URL.
S21.4.1 — Install docs describe PyPI
State: Closed
Acceptance:
- No current page tells a reader to declare the pykit index or to install by git URL as the main route.
- The root site and every package site build with
--strict.
Acceptance
set -euo pipefail
absent() { local rc=0; rg -q --hidden --glob '!.git' "$@" </dev/null || rc=$?; [ "$rc" -eq 1 ]; }
absent 'github.io/pykit/simple' --glob '!consuming-packages.md' README.md packages/*/README.md packages/*/docs docs/guides docs/runbooks
absent 'tool.uv.index' README.md packages/*/README.md packages/*/docs docs/runbooks
uv run --group docs mkdocs build --strict -q
for d in packages/*/; do uv run --group docs mkdocs build --strict -q -f "$d/mkdocs.yml"; done
docs/guides/consuming-packages.md may still name the old index under Moving
off the pykit index, so the first check leaves it out.