Fix pip install -e . editable-install failures - #448
Open
Ammar Hashmi (ammar-iitm) wants to merge 1 commit into
Open
Ammar Hashmi (ammar-iitm) wants to merge 1 commit into
Ammar Hashmi (ammar-iitm) wants to merge 1 commit into
Conversation
- pyproject.toml declared `setuptools>=61.0`, but PEP 660 editable-install support (the `editable_wheel` build hook `pip install -e .` needs for a pyproject.toml-only project with no setup.py) only landed in setuptools 64.0.0. Bump the floor so environments that respect the build-system requirement don't resolve to a setuptools too old to support it. - Add a troubleshooting note next to each `pip install -e .` / `pip install -e .[streamingtts]` step in the docs, covering the two distinct errors reported in microsoft#402: the "editable mode currently requires a setuptools-based build" failure (old pip/setuptools), and zsh glob-expanding the `[streamingtts]` extras bracket when unquoted. Both fixes were already independently rediscovered by three different users in the issue thread; this just puts them where people hit the error. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018vBGcq8YxMgbF58qx7C4cP
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.
Summary
Fixes #402:
pip install -e .fails with:Three separate users hit this independently in the issue thread over a few months and each rediscovered the same fix (upgrade pip/setuptools; quote the extras on zsh) without it ever landing anywhere in the repo. This PR puts both fixes where people will actually see them.
Root cause
Building an editable install for a
pyproject.toml-only project (nosetup.py) requires the PEP 660editable_wheelbuild hook, which needspip>=21.3andsetuptools>=64.0.pyproject.tomlhere declaredsetuptools>=61.0— three minor versions before PEP 660 support existed — so an environment that honors that floor (e.g.--no-build-isolationagainst an older locally-installed setuptools) can legitimately resolve to a setuptools that can't do the editable build at all, producing exactly this error.A second, unrelated error also showed up in the same thread:
zsh: no matches found: .[streamingtts]— zsh glob-expands the unquoted[...]inpip install -e .[streamingtts].Changes
pyproject.toml:setuptools>=61.0→setuptools>=64.0(the actual minimum for PEP 660 editable installs).docs/vibevoice-asr.md,docs/vibevoice-asr-streaming.md,docs/vibevoice-realtime-0.5b.md: added a troubleshooting note next to eachpip install -e .step with the exact upgrade command (python -m pip install --upgrade "pip>=24.0" "setuptools>=64.0" wheel), and — on the one page using extras — the zsh quoting fix (pip install -e ".[streamingtts]").Test plan
python3 -c "import tomllib; tomllib.load(open('pyproject.toml','rb'))"—pyproject.tomlstill parses🤖 Generated with Claude Code
https://claude.ai/code/session_018vBGcq8YxMgbF58qx7C4cP