Skip to content

Update docs to add git+ssh install example #12753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update docs to add git+ssh install example #12753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e3391a4
Update docs to add git+ssh install example
waketzheng Jun 1, 2024
676fde3
Use {admonition} for example command
waketzheng Jun 6, 2024
0c302d9
Add news
waketzheng Jun 7, 2024
0256604
Add example for install by vcs
waketzheng Jul 16, 2024
6620d4a
Change example to use full commit hash
waketzheng Aug 3, 2024
cc6d6f4
Merge branch 'main' into update-docs
waketzheng Aug 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/html/topics/vcs-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ The supported schemes are `git+file`, `git+https`, `git+ssh`, `git+http`,
`git+git` and `git`. Here are some of the supported forms:

```none
MyProject @ git+ssh://[email protected]/MyProject
MyProject @ git+file:///home/user/projects/MyProject
MyProject @ git+https://git.example.com/MyProject
MyProject @ git+ssh://[email protected]/MyProject
```

```{warning}
Expand All @@ -43,7 +43,13 @@ MyProject @ git+https://git.example.com/MyProject.git@refs/pull/123/head

When passing a commit hash, specifying a full hash is preferable to a partial
hash because a full hash allows pip to operate more efficiently (e.g. by
making fewer network calls).
making fewer network calls). Examples:

```{pip-cli}
$ pip install "virtualenv @ git+https://github.com/pypa/virtualenv.git@b6c052bdac73138251dc46abda6154f3a0bf8a14"
$ pip install "setuptools @ git+ssh://[email protected]/pypa/setuptools.git@780a782ccec6724fcec3f36de120fac07cb1fbba"
```


### Mercurial

Expand Down
1 change: 1 addition & 0 deletions news/12753.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add examples for installing package by git+https/ssh with full commit hash.