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
@@ -43,6 +43,8 @@ when creating a virtual environment) or after explicitly uninstalling
Command line interface
----------------------
.. program:: ensurepip
The command line interface is invoked using the interpreter's ``-m`` switch.
The simplest possible invocation is::
Expand All
@@ -61,26 +63,34 @@ By default, ``pip`` is installed into the current virtual environment
active virtual environment). The installation location can be controlled
through two additional command line options:
* :samp:`--root {dir}`: Installs ``pip`` relative to the given root directory
rather than the root of the currently active virtual environment (if any)
or the default root for the current Python installation.
* ``--user``: Installs ``pip`` into the user site packages directory rather
than globally for the current Python installation (this option is not
permitted inside an active virtual environment).
.. option:: --root <dir>
Installs ``pip`` relative to the given root directory rather than the root
of the currently active virtual environment (if any) or the default root
for the current Python installation.
.. option:: --user
Installs ``pip`` into the user site packages directory rather than globally
for the current Python installation (this option is not permitted inside an
active virtual environment).
By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where
X.Y stands for the version of Python used to invoke ``ensurepip``). The
scripts installed can be controlled through two additional command line
options:
* ``--altinstall``: if an alternate installation is requested, the ``pipX``
script will *not* be installed.
.. option:: --altinstall
* ``--default-pip``: if a "default pip" installation is requested, the
``pip`` script will be installed in addition to the two regular scripts.
If an alternate installation is requested, the ``pipX`` script will *not* be
installed.
Providing both of the script selection options will trigger an exception.
.. option:: --default-pip
If a "default pip" installation is requested, the ``pip`` script will be
installed in addition to the two regular scripts.
Providing both of the script selection options will trigger an exception.
Module API
----------
Expand Down
Expand Up
@@ -136,3 +146,4 @@ Module API
``pip``, but other software should not assume those dependencies will
always be present by default (as the dependencies may be removed in a
future version of ``pip``).
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.
[3.12] gh-130160: use .. program:: directive for documenting ensurepip CLI (gh-130253) #130258
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
[3.12] gh-130160: use .. program:: directive for documenting ensurepip CLI (gh-130253) #130258
Filter by extension
Viewed files
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing