docs(py): the pip install git+... command in the README cannot work - #489
Open
boleklebovski wants to merge 1 commit into
Open
docs(py): the pip install git+... command in the README cannot work#489boleklebovski wants to merge 1 commit into
pip install git+... command in the README cannot work#489boleklebovski wants to merge 1 commit into
Conversation
pip clones the URL it is given; a /blob/ path is a GitHub web page, not a repository, so the documented command always fails. Signed-off-by: boleklebovski <160799963+boleklebovski@users.noreply.github.com>
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.
Problem
v4-client-py-v2/README.mddocuments installing from source twice — line 32 (Quick install) and line 54 (Installation) — with:pip'sgit+handler hands the URL straight togit clone./blob/main/...is a GitHub web UI path that serves HTML, not a git repository, so the clone fails and the install never gets started. There is also no way to express "install from this subdirectory" with a/blob/path.Fix
Use the repository URL with pip's
subdirectoryfragment, which is the supported way to install a package that lives in a monorepo subfolder:Two lines, both occurrences.
Note on overlap
Open PR #488 also edits this file, but it adds lines at the top (hunk
@@ -10,6 +10,8 @@) and does not touch either install command, so the two should not conflict.