From 4936d98b58a13dd12906c7dc5b057a70c9e43c48 Mon Sep 17 00:00:00 2001 From: jeqcho Date: Mon, 13 Jul 2026 16:06:02 -0700 Subject: [PATCH] docs: drop stale pre-PyPI two-step install instructions worldevals and inspect-robots have both been on PyPI since 0.3.x, but the catalog home page and CLAUDE.md still told users to install from git tags (two commands, pinned to inspect-robots v0.3.0). Replace both with 'pip install worldevals' and note in CLAUDE.md why direct git references must not come back: PyPI rejects wheels with direct-URL deps, which would break the release workflow at upload. Surfaced while reviewing #23/#24; closes out the stale-docs remainder of #2. Co-Authored-By: Claude Fable 5 --- CLAUDE.md | 16 ++++++++-------- scripts/gen_catalog.py | 4 +--- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 736b353..02031c3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -34,14 +34,14 @@ The package is small and self-documenting, so there's no separate `src/` guide. ## Working here (important gotchas) -- **Dependency on Inspect Robots is a git tag** (`[tool.uv.sources] inspect-robots = { git = - ..., tag = "v0.3.0" }`); it's used only by the `tasks` command (to read the - Inspect Robots registry). `tool.uv.sources` is **uv-only**: plain pip ignores it, - and `inspect-robots` isn't on PyPI, so every pip-facing install instruction is - **two-step** — `pip install "inspect-robots @ - git+https://github.com/robocurve/inspect-robots@v0.3.0"` first, then the - package. Keep README, `catalog.py` install strings, `scripts/gen_catalog.py`, - and `docs/contributing.md` in that form. +- **Dependency on Inspect Robots comes from PyPI** (`inspect-robots>=0.3` in + `pyproject.toml`); it's used only by the `tasks` command (to read the + Inspect Robots registry). Both `inspect-robots` and `worldevals` are published + to PyPI, so every pip-facing install instruction is one line: `pip install + worldevals`. Never reintroduce a git direct reference in `dependencies`: + PyPI rejects wheels whose deps are direct URL refs, so the next release + upload would fail. Keep README, `catalog.py` install strings, + `scripts/gen_catalog.py`, and `docs/contributing.md` on the PyPI form. - **Conda is active in this shell** — `uv pip install -e .` lands in conda base, not `.venv`. Activate first: `source .venv/bin/activate && export VIRTUAL_ENV="$PWD/.venv"` (or use `uv run`). diff --git a/scripts/gen_catalog.py b/scripts/gen_catalog.py index 9bb70aa..15e9977 100644 --- a/scripts/gen_catalog.py +++ b/scripts/gen_catalog.py @@ -82,9 +82,7 @@ def render_home() -> str: ## Browse from the command line ```bash -# Inspect Robots isn't on PyPI yet, so install it from its git tag first: -pip install "inspect-robots @ git+https://github.com/robocurve/inspect-robots@v0.3.0" -pip install "worldevals @ git+https://github.com/robocurve/worldevals" +pip install worldevals worldevals list # all benchmarks worldevals list --tag bimanual # filter by tag