-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Quote all install command components that aren't a bare package name
* As a means to make things easier for new users, quote everything in a `pip install` command that is part of a package that isn't just a bare package name. * Use single quotes for Linux/Mac and use double quotes for Windows to follow existing style conventions.
- Loading branch information
1 parent
c3fd5d3
commit 3a7c500
Showing
1 changed file
with
24 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,7 +11,7 @@ Usage | |
|
||
.. tab:: Unix/macOS | ||
|
||
.. pip-command-usage:: install "python -m pip" | ||
.. pip-command-usage:: install 'python -m pip' | ||
|
||
.. tab:: Windows | ||
|
||
|
@@ -277,16 +277,16 @@ Examples | |
.. code-block:: shell | ||
python -m pip install SomePackage # latest version | ||
python -m pip install SomePackage==1.0.4 # specific version | ||
python -m pip install 'SomePackage==1.0.4' # specific version | ||
python -m pip install 'SomePackage>=1.0.4' # minimum version | ||
.. tab:: Windows | ||
|
||
.. code-block:: shell | ||
py -m pip install SomePackage # latest version | ||
py -m pip install SomePackage==1.0.4 # specific version | ||
py -m pip install 'SomePackage>=1.0.4' # minimum version | ||
py -m pip install "SomePackage==1.0.4" # specific version | ||
py -m pip install "SomePackage>=1.0.4" # minimum version | ||
#. Install a list of requirements specified in a file. See the :ref:`Requirements files <Requirements Files>`. | ||
|
@@ -349,13 +349,13 @@ Examples | |
|
||
.. code-block:: shell | ||
python -m pip install SomeProject@git+https://git.repo/[email protected] | ||
python -m pip install 'SomeProject@git+https://git.repo/[email protected]' | ||
.. tab:: Windows | ||
|
||
.. code-block:: shell | ||
py -m pip install SomeProject@git+https://git.repo/[email protected] | ||
py -m pip install "SomeProject@git+https://git.repo/[email protected]" | ||
#. Install a project from VCS in "editable" mode. See the sections on :doc:`../topics/vcs-support` and :ref:`Editable Installs <editable-installs>`. | ||
|
@@ -364,20 +364,20 @@ Examples | |
|
||
.. code-block:: shell | ||
python -m pip install -e git+https://git.repo/some_pkg.git#egg=SomePackage # from git | ||
python -m pip install -e hg+https://hg.repo/some_pkg.git#egg=SomePackage # from mercurial | ||
python -m pip install -e svn+svn://svn.repo/some_pkg/trunk/#egg=SomePackage # from svn | ||
python -m pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomePackage # from 'feature' branch | ||
python -m pip install -e "git+https://git.repo/some_repo.git#egg=subdir&subdirectory=subdir_path" # install a python package from a repo subdirectory | ||
python -m pip install -e 'git+https://git.repo/some_pkg.git#egg=SomePackage' # from git | ||
python -m pip install -e 'hg+https://hg.repo/some_pkg.git#egg=SomePackage' # from mercurial | ||
python -m pip install -e 'svn+svn://svn.repo/some_pkg/trunk/#egg=SomePackage' # from svn | ||
python -m pip install -e 'git+https://git.repo/some_pkg.git@feature#egg=SomePackage' # from 'feature' branch | ||
python -m pip install -e 'git+https://git.repo/some_repo.git#egg=subdir&subdirectory=subdir_path' # install a python package from a repo subdirectory | ||
.. tab:: Windows | ||
|
||
.. code-block:: shell | ||
py -m pip install -e git+https://git.repo/some_pkg.git#egg=SomePackage # from git | ||
py -m pip install -e hg+https://hg.repo/some_pkg.git#egg=SomePackage # from mercurial | ||
py -m pip install -e svn+svn://svn.repo/some_pkg/trunk/#egg=SomePackage # from svn | ||
py -m pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomePackage # from 'feature' branch | ||
py -m pip install -e "git+https://git.repo/some_pkg.git#egg=SomePackage" # from git | ||
py -m pip install -e "hg+https://hg.repo/some_pkg.git#egg=SomePackage" # from mercurial | ||
py -m pip install -e "svn+svn://svn.repo/some_pkg/trunk/#egg=SomePackage" # from svn | ||
py -m pip install -e "git+https://git.repo/some_pkg.git@feature#egg=SomePackage" # from 'feature' branch | ||
py -m pip install -e "git+https://git.repo/some_repo.git#egg=subdir&subdirectory=subdir_path" # install a python package from a repo subdirectory | ||
#. Install a package with `extras`_. | ||
|
@@ -408,33 +408,33 @@ Examples | |
|
||
.. code-block:: shell | ||
python -m pip install ./downloads/SomePackage-1.0.4.tar.gz | ||
python -m pip install http://my.package.repo/SomePackage-1.0.4.zip | ||
python -m pip install './downloads/SomePackage-1.0.4.tar.gz' | ||
python -m pip install 'http://my.package.repo/SomePackage-1.0.4.zip' | ||
.. tab:: Windows | ||
|
||
.. code-block:: shell | ||
py -m pip install ./downloads/SomePackage-1.0.4.tar.gz | ||
py -m pip install http://my.package.repo/SomePackage-1.0.4.zip | ||
py -m pip install "./downloads/SomePackage-1.0.4.tar.gz" | ||
py -m pip install "http://my.package.repo/SomePackage-1.0.4.zip" | ||
#. Install a particular source archive file following :pep:`440` direct references. | ||
|
||
.. tab:: Unix/macOS | ||
|
||
.. code-block:: shell | ||
python -m pip install SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl | ||
python -m pip install "SomeProject @ http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl" | ||
python -m pip install SomeProject@http://my.package.repo/1.2.3.tar.gz | ||
python -m pip install 'SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl' | ||
python -m pip install 'SomeProject @ http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl' | ||
python -m pip install 'SomeProject@http://my.package.repo/1.2.3.tar.gz' | ||
.. tab:: Windows | ||
|
||
.. code-block:: shell | ||
py -m pip install SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl | ||
py -m pip install "SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl" | ||
py -m pip install "SomeProject @ http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl" | ||
py -m pip install SomeProject@http://my.package.repo/1.2.3.tar.gz | ||
py -m pip install "SomeProject@http://my.package.repo/1.2.3.tar.gz" | ||
#. Install from alternative package repositories. | ||
|
||
|