diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst
index 9810bfaa4..1bc4a5516 100644
--- a/docs/html/development/getting-started.rst
+++ b/docs/html/development/getting-started.rst
@@ -44,19 +44,19 @@ You can then invoke your local source tree pip normally.
.. code-block:: shell
- $ virtualenv venv # You can also use "python -m venv venv" from python3.3+
- $ source venv/bin/activate
- $ python -m pip install -e .
- $ python -m pip --version
+ virtualenv venv # You can also use "python -m venv venv" from python3.3+
+ source venv/bin/activate
+ python -m pip install -e .
+ python -m pip --version
.. group-tab:: Windows
.. code-block:: shell
- C:\> virtualenv venv # You can also use "py -m venv venv" from python3.3+
- C:\> source venv/bin/activate
- C:\> py -m pip install -e .
- C:\> py -m pip --version
+ virtualenv venv # You can also use "py -m venv venv" from python3.3+
+ venv\Scripts\activate
+ py -m pip install -e .
+ py -m pip --version
Running Tests
=============
diff --git a/docs/html/installing.rst b/docs/html/installing.rst
index 14d517160..e6717881a 100644
--- a/docs/html/installing.rst
+++ b/docs/html/installing.rst
@@ -34,13 +34,13 @@ have downloaded ``get-pip.py``:
.. code-block:: shell
- $ python get-pip.py
+ python get-pip.py
.. group-tab:: Windows
.. code-block:: shell
- C:\> py get-pip.py
+ py get-pip.py
.. warning::
@@ -87,13 +87,13 @@ Install from local copies of pip and setuptools:
.. code-block:: shell
- $ python get-pip.py --no-index --find-links=/local/copies
+ python get-pip.py --no-index --find-links=/local/copies
.. group-tab:: Windows
.. code-block:: shell
- C:\> py get-pip.py --no-index --find-links=/local/copies
+ py get-pip.py --no-index --find-links=/local/copies
Install to the user site [3]_:
@@ -103,13 +103,13 @@ Install to the user site [3]_:
.. code-block:: shell
- $ python get-pip.py --user
+ python get-pip.py --user
.. group-tab:: Windows
.. code-block:: shell
- C:\> py get-pip.py --user
+ py get-pip.py --user
Install behind a proxy:
@@ -119,13 +119,13 @@ Install behind a proxy:
.. code-block:: shell
- $ python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
+ python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
.. group-tab:: Windows
.. code-block:: shell
- C:\> py get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
+ py get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
``get-pip.py`` can also be used to install a specified combination of ``pip``,
``setuptools``, and ``wheel`` using the same requirements syntax as pip:
@@ -136,13 +136,13 @@ Install behind a proxy:
.. code-block:: shell
- $ python get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
+ python get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
.. group-tab:: Windows
.. code-block:: shell
- C:\> py get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
+ py get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
Using Linux Package Managers
============================
@@ -162,13 +162,13 @@ Upgrading pip
.. code-block:: shell
- $ python -m pip install -U pip
+ python -m pip install -U pip
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -U pip
+ py -m pip install -U pip
.. _compatibility-requirements:
diff --git a/docs/html/reference/pip.rst b/docs/html/reference/pip.rst
index 3694ca7f5..a0c1148bf 100644
--- a/docs/html/reference/pip.rst
+++ b/docs/html/reference/pip.rst
@@ -238,13 +238,13 @@ included in the command as follows:
.. code-block:: shell
- $ python setup.py BUILD COMMAND
+ python setup.py BUILD COMMAND
.. group-tab:: Windows
.. code-block:: shell
- C:\> py setup.py BUILD COMMAND
+ py setup.py BUILD COMMAND
The options are passed unmodified, and presently offer direct access to the
distutils command line. Use of ``--global-option`` and ``--build-option``
diff --git a/docs/html/reference/pip_download.rst b/docs/html/reference/pip_download.rst
index d3c217b94..141b6e1fa 100644
--- a/docs/html/reference/pip_download.rst
+++ b/docs/html/reference/pip_download.rst
@@ -70,17 +70,17 @@ Examples
.. code-block:: shell
- $ python -m pip download SomePackage
- $ python -m pip download -d . SomePackage # equivalent to above
- $ python -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
+ python -m pip download SomePackage
+ python -m pip download -d . SomePackage # equivalent to above
+ python -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip download SomePackage
- C:\> py -m pip download -d . SomePackage # equivalent to above
- C:\> py -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
+ py -m pip download SomePackage
+ py -m pip download -d . SomePackage # equivalent to above
+ py -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
#. Download a package and all of its dependencies with OSX specific interpreter constraints.
@@ -96,23 +96,23 @@ Examples
.. code-block:: shell
- $ python -m pip download \
- --only-binary=:all: \
- --platform macosx-10_10_x86_64 \
- --python-version 27 \
- --implementation cp \
- SomePackage
+ python -m pip download \
+ --only-binary=:all: \
+ --platform macosx-10_10_x86_64 \
+ --python-version 27 \
+ --implementation cp \
+ SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip download ^
- --only-binary=:all: ^
- --platform macosx-10_10_x86_64 ^
- --python-version 27 ^
- --implementation cp ^
- SomePackage
+ py -m pip download ^
+ --only-binary=:all: ^
+ --platform macosx-10_10_x86_64 ^
+ --python-version 27 ^
+ --implementation cp ^
+ SomePackage
#. Download a package and its dependencies with linux specific constraints.
Force the interpreter to be any minor version of py3k, and only accept
@@ -124,25 +124,25 @@ Examples
.. code-block:: shell
- $ python -m pip download \
- --only-binary=:all: \
- --platform linux_x86_64 \
- --python-version 3 \
- --implementation cp \
- --abi cp34m \
- SomePackage
+ python -m pip download \
+ --only-binary=:all: \
+ --platform linux_x86_64 \
+ --python-version 3 \
+ --implementation cp \
+ --abi cp34m \
+ SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip download ^
- --only-binary=:all: ^
- --platform linux_x86_64 ^
- --python-version 3 ^
- --implementation cp ^
- --abi cp34m ^
- SomePackage
+ py -m pip download ^
+ --only-binary=:all: ^
+ --platform linux_x86_64 ^
+ --python-version 3 ^
+ --implementation cp ^
+ --abi cp34m ^
+ SomePackage
#. Force platform, implementation, and abi agnostic deps.
@@ -152,25 +152,25 @@ Examples
.. code-block:: shell
- $ python -m pip download \
- --only-binary=:all: \
- --platform any \
- --python-version 3 \
- --implementation py \
- --abi none \
- SomePackage
+ python -m pip download \
+ --only-binary=:all: \
+ --platform any \
+ --python-version 3 \
+ --implementation py \
+ --abi none \
+ SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip download ^
- --only-binary=:all: ^
- --platform any ^
- --python-version 3 ^
- --implementation py ^
- --abi none ^
- SomePackage
+ py -m pip download ^
+ --only-binary=:all: ^
+ --platform any ^
+ --python-version 3 ^
+ --implementation py ^
+ --abi none ^
+ SomePackage
#. Even when overconstrained, this will still correctly fetch the pip universal wheel.
diff --git a/docs/html/reference/pip_freeze.rst b/docs/html/reference/pip_freeze.rst
index cd180e095..91c80979a 100644
--- a/docs/html/reference/pip_freeze.rst
+++ b/docs/html/reference/pip_freeze.rst
@@ -72,12 +72,12 @@ Examples
.. code-block:: shell
- $ env1/bin/python -m pip freeze > requirements.txt
- $ env2/bin/python -m pip install -r requirements.txt
+ env1/bin/python -m pip freeze > requirements.txt
+ env2/bin/python -m pip install -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> env1\bin\python -m pip freeze > requirements.txt
- C:\> env2\bin\python -m pip install -r requirements.txt
+ env1\bin\python -m pip freeze > requirements.txt
+ env2\bin\python -m pip install -r requirements.txt
diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst
index 67cfd03c6..b2da26240 100644
--- a/docs/html/reference/pip_install.rst
+++ b/docs/html/reference/pip_install.rst
@@ -422,13 +422,13 @@ Then, to install from this repository, the syntax would be:
.. code-block:: shell
- $ python -m pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"
+ python -m pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"
+ py -m pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"
Git
@@ -760,13 +760,13 @@ Hash-checking mode also works with :ref:`pip download` and :ref:`pip wheel`. A
.. code-block:: shell
- $ python -m pip install --no-deps -e .
+ python -m pip install --no-deps -e .
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --no-deps -e .
+ py -m pip install --no-deps -e .
Instead of ``python setup.py install``, use...
@@ -777,13 +777,13 @@ Hash-checking mode also works with :ref:`pip download` and :ref:`pip wheel`. A
.. code-block:: shell
- $ python -m pip install --no-deps .
+ python -m pip install --no-deps .
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --no-deps .
+ py -m pip install --no-deps .
Hashes from PyPI
^^^^^^^^^^^^^^^^
@@ -809,13 +809,13 @@ You can install local projects by specifying the project path to pip:
.. code-block:: shell
- $ python -m pip install path/to/SomeProject
+ python -m pip install path/to/SomeProject
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install path/to/SomeProject
+ py -m pip install path/to/SomeProject
During regular installation, pip will copy the entire project directory to a
@@ -841,15 +841,15 @@ You can install local projects or VCS projects in "editable" mode:
.. code-block:: shell
- $ python -m pip install -e path/to/SomeProject
- $ python -m pip install -e git+http://repo/my_project.git#egg=SomeProject
+ python -m pip install -e path/to/SomeProject
+ python -m pip install -e git+http://repo/my_project.git#egg=SomeProject
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -e path/to/SomeProject
- C:\> py -m pip install -e git+http://repo/my_project.git#egg=SomeProject
+ py -m pip install -e path/to/SomeProject
+ py -m pip install -e git+http://repo/my_project.git#egg=SomeProject
(See the :ref:`VCS Support` section above for more information on VCS-related syntax.)
@@ -963,17 +963,17 @@ 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' # minimum version
+ 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' # minimum version
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage # latest version
- C:\> py -m pip install SomePackage==1.0.4 # specific version
- C:\> py -m pip install 'SomePackage>=1.0.4' # minimum version
+ 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
#. Install a list of requirements specified in a file. See the :ref:`Requirements files `.
@@ -984,13 +984,13 @@ Examples
.. code-block:: shell
- $ python -m pip install -r requirements.txt
+ python -m pip install -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -r requirements.txt
+ py -m pip install -r requirements.txt
#. Upgrade an already installed ``SomePackage`` to the latest from PyPI.
@@ -1001,13 +1001,13 @@ Examples
.. code-block:: shell
- $ python -m pip install --upgrade SomePackage
+ python -m pip install --upgrade SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --upgrade SomePackage
+ py -m pip install --upgrade SomePackage
#. Install a local project in "editable" mode. See the section on :ref:`Editable Installs `.
@@ -1018,15 +1018,15 @@ Examples
.. code-block:: shell
- $ python -m pip install -e . # project in current directory
- $ python -m pip install -e path/to/project # project in another directory
+ python -m pip install -e . # project in current directory
+ python -m pip install -e path/to/project # project in another directory
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -e . # project in current directory
- C:\> py -m pip install -e path/to/project # project in another directory
+ py -m pip install -e . # project in current directory
+ py -m pip install -e path/to/project # project in another directory
#. Install a project from VCS
@@ -1037,13 +1037,13 @@ Examples
.. code-block:: shell
- $ python -m pip install SomeProject@git+https://git.repo/some_pkg.git@1.3.1
+ python -m pip install SomeProject@git+https://git.repo/some_pkg.git@1.3.1
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomeProject@git+https://git.repo/some_pkg.git@1.3.1
+ py -m pip install SomeProject@git+https://git.repo/some_pkg.git@1.3.1
#. Install a project from VCS in "editable" mode. See the sections on :ref:`VCS Support ` and :ref:`Editable Installs `.
@@ -1054,21 +1054,21 @@ 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 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 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
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -e git+https://git.repo/some_pkg.git#egg=SomePackage # from git
- C:\> py -m pip install -e hg+https://hg.repo/some_pkg.git#egg=SomePackage # from mercurial
- C:\> py -m pip install -e svn+svn://svn.repo/some_pkg/trunk/#egg=SomePackage # from svn
- C:\> py -m pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomePackage # from 'feature' branch
- C:\> 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
+ 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 `setuptools extras`_.
@@ -1079,21 +1079,21 @@ Examples
.. code-block:: shell
- $ python -m pip install SomePackage[PDF]
- $ python -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
- $ python -m pip install .[PDF] # project in current directory
- $ python -m pip install SomePackage[PDF]==3.0
- $ python -m pip install SomePackage[PDF,EPUB] # multiple extras
+ python -m pip install SomePackage[PDF]
+ python -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
+ python -m pip install .[PDF] # project in current directory
+ python -m pip install SomePackage[PDF]==3.0
+ python -m pip install SomePackage[PDF,EPUB] # multiple extras
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage[PDF]
- C:\> py -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
- C:\> py -m pip install .[PDF] # project in current directory
- C:\> py -m pip install SomePackage[PDF]==3.0
- C:\> py -m pip install SomePackage[PDF,EPUB] # multiple extras
+ py -m pip install SomePackage[PDF]
+ py -m pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
+ py -m pip install .[PDF] # project in current directory
+ py -m pip install SomePackage[PDF]==3.0
+ py -m pip install SomePackage[PDF,EPUB] # multiple extras
#. Install a particular source archive file.
@@ -1104,15 +1104,15 @@ 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
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install ./downloads/SomePackage-1.0.4.tar.gz
- C:\> 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.
@@ -1123,17 +1123,17 @@ Examples
.. 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
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl
- C:\> py -m pip install "SomeProject @ http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl"
- C:\> py -m pip install SomeProject@http://my.package.repo/1.2.3.tar.gz
+ 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
#. Install from alternative package repositories.
@@ -1146,13 +1146,13 @@ Examples
.. code-block:: shell
- $ python -m pip install --index-url http://my.package.repo/simple/ SomePackage
+ python -m pip install --index-url http://my.package.repo/simple/ SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --index-url http://my.package.repo/simple/ SomePackage
+ py -m pip install --index-url http://my.package.repo/simple/ SomePackage
Search an additional index during install, in addition to `PyPI`_
@@ -1163,13 +1163,13 @@ Examples
.. code-block:: shell
- $ python -m pip install --extra-index-url http://my.package.repo/simple SomePackage
+ python -m pip install --extra-index-url http://my.package.repo/simple SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --extra-index-url http://my.package.repo/simple SomePackage
+ py -m pip install --extra-index-url http://my.package.repo/simple SomePackage
Install from a local flat directory containing archives (and don't scan indexes):
@@ -1180,17 +1180,17 @@ Examples
.. code-block:: shell
- $ python -m pip install --no-index --find-links=file:///local/dir/ SomePackage
- $ python -m pip install --no-index --find-links=/local/dir/ SomePackage
- $ python -m pip install --no-index --find-links=relative/dir/ SomePackage
+ python -m pip install --no-index --find-links=file:///local/dir/ SomePackage
+ python -m pip install --no-index --find-links=/local/dir/ SomePackage
+ python -m pip install --no-index --find-links=relative/dir/ SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --no-index --find-links=file:///local/dir/ SomePackage
- C:\> py -m pip install --no-index --find-links=/local/dir/ SomePackage
- C:\> py -m pip install --no-index --find-links=relative/dir/ SomePackage
+ py -m pip install --no-index --find-links=file:///local/dir/ SomePackage
+ py -m pip install --no-index --find-links=/local/dir/ SomePackage
+ py -m pip install --no-index --find-links=relative/dir/ SomePackage
#. Find pre-release and development versions, in addition to stable versions. By default, pip only finds stable versions.
@@ -1201,13 +1201,13 @@ Examples
.. code-block:: shell
- $ python -m pip install --pre SomePackage
+ python -m pip install --pre SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --pre SomePackage
+ py -m pip install --pre SomePackage
#. Install packages from source.
@@ -1220,13 +1220,13 @@ Examples
.. code-block:: shell
- $ python -m pip install SomePackage1 SomePackage2 --no-binary :all:
+ python -m pip install SomePackage1 SomePackage2 --no-binary :all:
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage1 SomePackage2 --no-binary :all:
+ py -m pip install SomePackage1 SomePackage2 --no-binary :all:
Specify ``SomePackage1`` to be installed from source:
@@ -1236,13 +1236,13 @@ Examples
.. code-block:: shell
- $ python -m pip install SomePackage1 SomePackage2 --no-binary SomePackage1
+ python -m pip install SomePackage1 SomePackage2 --no-binary SomePackage1
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage1 SomePackage2 --no-binary SomePackage1
+ py -m pip install SomePackage1 SomePackage2 --no-binary SomePackage1
----
diff --git a/docs/html/reference/pip_wheel.rst b/docs/html/reference/pip_wheel.rst
index 0a11c6e25..5dd4b0328 100644
--- a/docs/html/reference/pip_wheel.rst
+++ b/docs/html/reference/pip_wheel.rst
@@ -40,13 +40,13 @@ In order for pip to build a wheel, ``setup.py`` must implement the
.. code-block:: shell
- $ python setup.py bdist_wheel -d TARGET
+ python setup.py bdist_wheel -d TARGET
.. group-tab:: Windows
.. code-block:: shell
- C:\> py setup.py bdist_wheel -d TARGET
+ py setup.py bdist_wheel -d TARGET
This command must create a wheel compatible with the invoking Python
@@ -68,13 +68,13 @@ example:
.. code-block:: shell
- $ python -m pip wheel --global-option bdist_ext --global-option -DFOO wheel
+ python -m pip wheel --global-option bdist_ext --global-option -DFOO wheel
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip wheel --global-option bdist_ext --global-option -DFOO wheel
+ py -m pip wheel --global-option bdist_ext --global-option -DFOO wheel
will result in a build command of
@@ -109,15 +109,15 @@ Examples
.. code-block:: shell
- $ python -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
- $ python -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
+ python -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
+ python -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
- C:\> py -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
+ py -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
+ py -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
#. Build a wheel for a package from source
@@ -127,10 +127,10 @@ Examples
.. code-block:: shell
- $ python -m pip wheel --no-binary SomePackage SomePackage
+ python -m pip wheel --no-binary SomePackage SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip wheel --no-binary SomePackage SomePackage
+ py -m pip wheel --no-binary SomePackage SomePackage
diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst
index 41cbb6404..aa18a6f66 100644
--- a/docs/html/user_guide.rst
+++ b/docs/html/user_guide.rst
@@ -17,7 +17,7 @@ to your system, which can be run from the command prompt as follows:
.. code-block:: shell
- $ python -m pip
+ python -m pip
``python -m pip`` executes pip using the Python interpreter you
specified as python. So ``/usr/bin/python3.7 -m pip`` means
@@ -27,7 +27,7 @@ to your system, which can be run from the command prompt as follows:
.. code-block:: shell
- C:\> py -m pip
+ py -m pip
``py -m pip`` executes pip using the latest Python interpreter you
have installed. For more details, read the `Python Windows launcher`_ docs.
@@ -49,17 +49,17 @@ Specifiers`
.. 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' # minimum version
+ 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' # minimum version
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage # latest version
- C:\> py -m pip install SomePackage==1.0.4 # specific version
- C:\> py -m pip install 'SomePackage>=1.0.4' # minimum version
+ 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
For more information and examples, see the :ref:`pip install` reference.
@@ -168,13 +168,13 @@ installed using :ref:`pip install` like so:
.. code-block:: shell
- $ python -m pip install -r requirements.txt
+ python -m pip install -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -r requirements.txt
+ py -m pip install -r requirements.txt
Details on the format of the files are here: :ref:`Requirements File Format`.
@@ -195,15 +195,15 @@ In practice, there are 4 common uses of Requirements files:
.. code-block:: shell
- $ python -m pip freeze > requirements.txt
- $ python -m pip install -r requirements.txt
+ python -m pip freeze > requirements.txt
+ python -m pip install -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip freeze > requirements.txt
- C:\> py -m pip install -r requirements.txt
+ py -m pip freeze > requirements.txt
+ py -m pip install -r requirements.txt
2. Requirements files are used to force pip to properly resolve dependencies.
As it is now, pip `doesn't have true dependency resolution
@@ -276,13 +276,13 @@ Use a constraints file like so:
.. code-block:: shell
- $ python -m pip install -c constraints.txt
+ python -m pip install -c constraints.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install -c constraints.txt
+ py -m pip install -c constraints.txt
Constraints files are used for exactly the same reason as requirements files
when you don't know exactly what things you want to install. For instance, say
@@ -326,13 +326,13 @@ To install directly from a wheel archive:
.. code-block:: shell
- $ python -m pip install SomePackage-1.0-py2.py3-none-any.whl
+ python -m pip install SomePackage-1.0-py2.py3-none-any.whl
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install SomePackage-1.0-py2.py3-none-any.whl
+ py -m pip install SomePackage-1.0-py2.py3-none-any.whl
For the cases where wheels are not available, pip offers :ref:`pip wheel` as a
@@ -351,15 +351,15 @@ directory:
.. code-block:: shell
- $ python -m pip install wheel
- $ python -m pip wheel --wheel-dir=/local/wheels -r requirements.txt
+ python -m pip install wheel
+ python -m pip wheel --wheel-dir=/local/wheels -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install wheel
- C:\> py -m pip wheel --wheel-dir=/local/wheels -r requirements.txt
+ py -m pip install wheel
+ py -m pip wheel --wheel-dir=/local/wheels -r requirements.txt
And *then* to install those requirements just using your local directory of
wheels (and not from PyPI):
@@ -370,13 +370,13 @@ wheels (and not from PyPI):
.. code-block:: shell
- $ python -m pip install --no-index --find-links=/local/wheels -r requirements.txt
+ python -m pip install --no-index --find-links=/local/wheels -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --no-index --find-links=/local/wheels -r requirements.txt
+ py -m pip install --no-index --find-links=/local/wheels -r requirements.txt
Uninstalling Packages
@@ -390,13 +390,13 @@ pip is able to uninstall most packages like so:
.. code-block:: shell
- $ python -m pip uninstall SomePackage
+ python -m pip uninstall SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip uninstall SomePackage
+ py -m pip uninstall SomePackage
pip also performs an automatic uninstall of an old version of a package
@@ -496,13 +496,13 @@ command:
.. code-block:: shell
- $ python -m pip search "query"
+ python -m pip search "query"
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip search "query"
+ py -m pip search "query"
The query will be used to search the names and summaries of all
packages.
@@ -670,13 +670,13 @@ For example, to set the default timeout:
.. code-block:: shell
- $ export PIP_DEFAULT_TIMEOUT=60
+ export PIP_DEFAULT_TIMEOUT=60
.. group-tab:: Windows
.. code-block:: shell
- C:\> set PIP_DEFAULT_TIMEOUT=60
+ set PIP_DEFAULT_TIMEOUT=60
This is the same as passing the option to pip directly:
@@ -686,13 +686,13 @@ This is the same as passing the option to pip directly:
.. code-block:: shell
- $ python -m pip --default-timeout=60 [...]
+ python -m pip --default-timeout=60 [...]
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip --default-timeout=60 [...]
+ py -m pip --default-timeout=60 [...]
For command line options which can be repeated, use a space to separate
multiple values. For example:
@@ -703,13 +703,13 @@ multiple values. For example:
.. code-block:: shell
- $ export PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"
+ export PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"
.. group-tab:: Windows
.. code-block:: shell
- C:\> set PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"
+ set PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"
is the same as calling:
@@ -720,13 +720,13 @@ is the same as calling:
.. code-block:: shell
- $ python -m pip install --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com
+ python -m pip install --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com
+ py -m pip install --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com
Options that do not take a value, but can be repeated (such as ``--verbose``)
@@ -770,15 +770,15 @@ pip comes with support for command line completion in bash, zsh and fish.
To setup for bash::
- $ python -m pip completion --bash >> ~/.profile
+ python -m pip completion --bash >> ~/.profile
To setup for zsh::
- $ python -m pip completion --zsh >> ~/.zprofile
+ python -m pip completion --zsh >> ~/.zprofile
To setup for fish::
- $ python -m pip completion --fish > ~/.config/fish/completions/pip.fish
+ python -m pip completion --fish > ~/.config/fish/completions/pip.fish
Alternatively, you can use the result of the ``completion`` command directly
with the eval function of your shell, e.g. by adding the following to your
@@ -805,13 +805,13 @@ First, download the archives that fulfill your requirements:
.. code-block:: shell
- $ python -m pip download --destination-directory DIR -r requirements.txt
+ python -m pip download --destination-directory DIR -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip download --destination-directory DIR -r requirements.txt
+ py -m pip download --destination-directory DIR -r requirements.txt
Note that ``pip download`` will look in your wheel cache first, before
@@ -826,13 +826,13 @@ this instead:
.. code-block:: shell
- $ python -m pip wheel --wheel-dir DIR -r requirements.txt
+ python -m pip wheel --wheel-dir DIR -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip wheel --wheel-dir DIR -r requirements.txt
+ py -m pip wheel --wheel-dir DIR -r requirements.txt
Then, to install from local only, you'll be using :ref:`--find-links
` and :ref:`--no-index ` like so:
@@ -843,13 +843,13 @@ Then, to install from local only, you'll be using :ref:`--find-links
.. code-block:: shell
- $ python -m pip install --no-index --find-links=DIR -r requirements.txt
+ python -m pip install --no-index --find-links=DIR -r requirements.txt
.. group-tab:: Windows
.. code-block:: shell
- C:\> -m pip install --no-index --find-links=DIR -r requirements.txt
+ py -m pip install --no-index --find-links=DIR -r requirements.txt
"Only if needed" Recursive Upgrade
@@ -876,15 +876,15 @@ behaviour was:
.. code-block:: shell
- $ python -m pip install --upgrade --no-deps SomePackage
- $ python -m pip install SomePackage
+ python -m pip install --upgrade --no-deps SomePackage
+ python -m pip install SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install --upgrade --no-deps SomePackage
- C:\> py -m pip install SomePackage
+ py -m pip install --upgrade --no-deps SomePackage
+ py -m pip install SomePackage
A proposal for an ``upgrade-all`` command is being considered as a safer
@@ -916,15 +916,15 @@ To install "SomePackage" into an environment with site.USER_BASE customized to
.. code-block:: shell
- $ export PYTHONUSERBASE=/myappenv
- $ python -m pip install --user SomePackage
+ export PYTHONUSERBASE=/myappenv
+ python -m pip install --user SomePackage
.. group-tab:: Windows
.. code-block:: shell
- C:\> set PYTHONUSERBASE=c:/myappenv
- C:\> py -m pip install --user SomePackage
+ set PYTHONUSERBASE=c:/myappenv
+ py -m pip install --user SomePackage
``pip install --user`` follows four rules:
@@ -1177,13 +1177,13 @@ like this:
.. code-block:: shell
- $ python -m pip install package_coffee==0.44.1 package_tea==4.3.0
+ python -m pip install package_coffee==0.44.1 package_tea==4.3.0
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install package_coffee==0.44.1 package_tea==4.3.0
+ py -m pip install package_coffee==0.44.1 package_tea==4.3.0
::
@@ -1295,13 +1295,13 @@ specifiers to *only* the more important package:
.. code-block:: shell
- $ python -m pip install package_coffee==0.44.1b0 package_tea
+ python -m pip install package_coffee==0.44.1b0 package_tea
.. group-tab:: Windows
.. code-block:: shell
- C:\> py -m pip install package_coffee==0.44.1b0 package_tea
+ py -m pip install package_coffee==0.44.1b0 package_tea
This will result in: