Skip to content

Commit d36954f

Browse files
Use req @ url syntax to install from remote VCS (#1207)
This form is deprecated and due for removal in a future pip release.
1 parent 8d3a552 commit d36954f

5 files changed

Lines changed: 13 additions & 13 deletions

File tree

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ sphinx-autobuild==0.7.1
33
sphinx-inline-tabs==2021.4.11b9
44
python-docs-theme==2022.1
55
sphinx-copybutton==0.5.0
6-
git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme
6+
pypa-docs-theme @ git+https://github.com/pypa/pypa-docs-theme.git

source/guides/distributing-packages-using-setuptools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ you want "bar" installed from VCS in editable mode, then you could construct a
693693
requirements file like so::
694694

695695
-e .
696-
-e git+https://somerepo/bar.git#egg=bar
696+
-e bar @ git+https://somerepo/bar.git
697697

698698
The first line says to install your project and any dependencies. The second
699699
line overrides the "bar" dependency, such that it's fulfilled from VCS, not

source/guides/installing-using-pip-and-virtual-environments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ example, you can install directly from a git repository:
349349

350350
.. code-block:: bash
351351
352-
git+https://github.com/GoogleCloudPlatform/google-auth-library-python.git#egg=google-auth
352+
google-auth @ git+https://github.com/GoogleCloudPlatform/google-auth-library-python.git
353353
354354
For more information on supported version control systems and syntax, see pip's
355355
documentation on :ref:`VCS Support <pip:VCS Support>`.

source/specifications/direct-url.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,10 +299,10 @@ Commands that generate a ``direct_url.json``:
299299

300300
* ``pip install https://example.com/app-1.0.tgz``
301301
* ``pip install https://example.com/app-1.0.whl``
302-
* ``pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"``
302+
* ``pip install "app&subdirectory=setup @ git+https://example.com/repo/app.git"``
303303
* ``pip install ./app``
304304
* ``pip install file:///home/user/app``
305-
* ``pip install --editable "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"``
305+
* ``pip install --editable "app&subdirectory=setup @ git+https://example.com/repo/app.git"``
306306
(in which case, ``url`` will be the local directory where the git repository has been
307307
cloned to, and ``dir_info`` will be present with ``"editable": true`` and no
308308
``vcs_info`` will be set)

source/tutorials/installing-packages.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -492,19 +492,19 @@ syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
492492

493493
.. code-block:: bash
494494
495-
python3 -m pip install -e git+https://git.repo/some_pkg.git#egg=SomeProject # from git
496-
python3 -m pip install -e hg+https://hg.repo/some_pkg#egg=SomeProject # from mercurial
497-
python3 -m pip install -e svn+svn://svn.repo/some_pkg/trunk/#egg=SomeProject # from svn
498-
python3 -m pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomeProject # from a branch
495+
python3 -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git # from git
496+
python3 -m pip install -e SomeProject @ hg+https://hg.repo/some_pkg # from mercurial
497+
python3 -m pip install -e SomeProject @ svn+svn://svn.repo/some_pkg/trunk/ # from svn
498+
python3 -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git@feature # from a branch
499499
500500
.. tab:: Windows
501501

502502
.. code-block:: bat
503503
504-
py -m pip install -e git+https://git.repo/some_pkg.git#egg=SomeProject # from git
505-
py -m pip install -e hg+https://hg.repo/some_pkg#egg=SomeProject # from mercurial
506-
py -m pip install -e svn+svn://svn.repo/some_pkg/trunk/#egg=SomeProject # from svn
507-
py -m pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomeProject # from a branch
504+
py -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git # from git
505+
py -m pip install -e SomeProject @ hg+https://hg.repo/some_pkg # from mercurial
506+
py -m pip install -e SomeProject @ svn+svn://svn.repo/some_pkg/trunk/ # from svn
507+
py -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git@feature # from a branch
508508
509509
Installing from other Indexes
510510
=============================

0 commit comments

Comments
 (0)