Skip to content

docs: uv-first source install, Python 3.11 stated up front#85

Merged
dustenhubbard merged 1 commit into
mainfrom
docs/source-install-uv
Jul 21, 2026
Merged

docs: uv-first source install, Python 3.11 stated up front#85
dustenhubbard merged 1 commit into
mainfrom
docs/source-install-uv

Conversation

@dustenhubbard

Copy link
Copy Markdown
Owner

Follow-up to #84's source-install docs after a real failure: a Mac with Python 3.14 hits the project's >=3.11,<3.12 pin when following the steps.

  • Python 3.11 requirement stated before any command in README and USER_GUIDE.
  • uv is now the recommended path (auto-downloads 3.11): uv venv --python 3.11 + uv pip install -e .; plain venv retained as the alternative.
  • 'Rerun the editable install only when pyproject.toml changes' added to the git-pull loop; Windows activation note in USER_GUIDE; CONTRIBUTING touched minimally (already stated 3.11); packaging docs verified already consistent.

Docs only. Suite: 1232 passed, 5 pre-existing xfails.

🤖 Generated with Claude Code

The maintainer hit `pip install -e .` failing on a Mac with Python 3.14
because the project pins `>=3.11,<3.12`. State the Python 3.11 requirement
before the venv step in every source-install block, and recommend uv (which
auto-downloads 3.11) with plain venv as the alternative for those who already
have python3.11.

- README.md "From source (developers)": 3.11 up front; uv-first block with
  venv alternative; note to rerun the editable install only when
  pyproject.toml changes.
- docs/USER_GUIDE.md "From source (Linux, other platforms, and developers)":
  same treatment for both the quick git+ install and the track-main editable
  clone; Windows activation note.
- CONTRIBUTING.md: mention `uv pip install -e .` alongside `pip install -e .`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@dustenhubbard
dustenhubbard enabled auto-merge (squash) July 21, 2026 19:21
@dustenhubbard
dustenhubbard merged commit 969c1b7 into main Jul 21, 2026
1 check passed
@dustenhubbard
dustenhubbard deleted the docs/source-install-uv branch July 21, 2026 19:22
dustenhubbard added a commit that referenced this pull request Jul 23, 2026
The maintainer hit `pip install -e .` failing on a Mac with Python 3.14
because the project pins `>=3.11,<3.12`. State the Python 3.11 requirement
before the venv step in every source-install block, and recommend uv (which
auto-downloads 3.11) with plain venv as the alternative for those who already
have python3.11.

- README.md "From source (developers)": 3.11 up front; uv-first block with
  venv alternative; note to rerun the editable install only when
  pyproject.toml changes.
- docs/USER_GUIDE.md "From source (Linux, other platforms, and developers)":
  same treatment for both the quick git+ install and the track-main editable
  clone; Windows activation note.
- CONTRIBUTING.md: mention `uv pip install -e .` alongside `pip install -e .`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant