2013-01-18 22:25:15 +01:00
|
|
|
.. _`Installation`:
|
2011-03-15 06:43:03 +01:00
|
|
|
|
2013-01-18 22:25:15 +01:00
|
|
|
Installation
|
|
|
|
============
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
Do I need to install pip?
|
|
|
|
-------------------------
|
2013-02-11 07:44:09 +01:00
|
|
|
|
2015-09-12 05:17:36 +02:00
|
|
|
pip is already installed if you're using Python 2 >=2.7.9 or Python 3 >=3.4
|
2016-06-05 16:46:33 +02:00
|
|
|
binaries downloaded from `python.org <https://www.python.org>`_, but you'll
|
|
|
|
need to :ref:`upgrade pip <Upgrading pip>`.
|
2013-03-12 06:02:39 +01:00
|
|
|
|
2015-09-12 05:27:26 +02:00
|
|
|
Additionally, pip will already be installed if you're working in a :ref:`Virtual
|
2016-03-06 01:52:28 +01:00
|
|
|
Environment <pypug:Creating and using Virtual Environments>` created by
|
2015-09-12 05:17:36 +02:00
|
|
|
:ref:`pypug:virtualenv` or :ref:`pyvenv <pypug:venv>`.
|
2013-03-12 06:02:39 +01:00
|
|
|
|
|
|
|
|
2014-01-10 05:13:30 +01:00
|
|
|
.. _`get-pip`:
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
Installing with get-pip.py
|
|
|
|
--------------------------
|
2014-01-10 05:13:30 +01:00
|
|
|
|
2014-01-21 05:59:27 +01:00
|
|
|
To install pip, securely download `get-pip.py
|
2014-12-08 13:15:12 +01:00
|
|
|
<https://bootstrap.pypa.io/get-pip.py>`_. [2]_
|
2014-01-10 05:13:30 +01:00
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
Then run the following:
|
2014-01-10 05:13:30 +01:00
|
|
|
|
2014-01-21 05:59:27 +01:00
|
|
|
::
|
2014-01-10 05:13:30 +01:00
|
|
|
|
2014-03-26 19:05:23 +01:00
|
|
|
python get-pip.py
|
2014-01-10 05:13:30 +01:00
|
|
|
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
.. warning::
|
|
|
|
|
|
|
|
Be cautious if you're using a Python install that's managed by your operating
|
|
|
|
system or another package manager. get-pip.py does not coordinate with
|
|
|
|
those tools, and may leave your system in an inconsistent state.
|
|
|
|
|
2016-01-22 14:47:20 +01:00
|
|
|
get-pip.py will also install :ref:`pypug:setuptools` [3]_ and :ref:`pypug:wheel`,
|
2015-09-08 01:56:10 +02:00
|
|
|
if they're not already. :ref:`pypug:setuptools` is required to install
|
|
|
|
:term:`source distributions <pypug:Source Distribution (or "sdist")>`. Both are
|
|
|
|
required to be able to build a :ref:`Wheel cache` (which improves installation
|
|
|
|
speed), although neither are required to install pre-built :term:`wheels
|
|
|
|
<pypug:Wheel>`.
|
|
|
|
|
2016-07-17 11:55:48 +02:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
The get-pip.py script is supported on the same python version as pip.
|
|
|
|
For the now unsupported Python 3.2, an alternate script is available
|
|
|
|
`here <https://bootstrap.pypa.io/3.2/get-pip.py>`_.
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
|
|
|
|
get-pip.py options
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
.. option:: --no-setuptools
|
|
|
|
|
|
|
|
If set, don't attempt to install :ref:`pypug:setuptools`
|
|
|
|
|
|
|
|
.. option:: --no-wheel
|
|
|
|
|
|
|
|
If set, don't attempt to install :ref:`pypug:wheel`
|
|
|
|
|
2014-04-10 01:53:52 +02:00
|
|
|
|
2014-04-09 07:57:22 +02:00
|
|
|
Additionally, ``get-pip.py`` supports using the :ref:`pip install options <pip
|
2014-04-10 01:53:52 +02:00
|
|
|
install Options>` and the :ref:`general options <General Options>`. Below are
|
|
|
|
some examples:
|
2014-04-09 07:57:22 +02:00
|
|
|
|
2014-04-10 01:53:52 +02:00
|
|
|
Install from local copies of pip and setuptools::
|
2014-04-09 07:57:22 +02:00
|
|
|
|
|
|
|
python get-pip.py --no-index --find-links=/local/copies
|
|
|
|
|
2015-05-09 20:58:55 +02:00
|
|
|
Install to the user site [4]_::
|
2014-04-09 07:57:22 +02:00
|
|
|
|
2014-04-10 01:53:52 +02:00
|
|
|
python get-pip.py --user
|
2011-04-04 16:45:07 +02:00
|
|
|
|
2014-04-10 01:53:52 +02:00
|
|
|
Install behind a proxy::
|
2013-08-29 05:43:20 +02:00
|
|
|
|
2014-04-10 01:53:52 +02:00
|
|
|
python get-pip.py --proxy="[user:passwd@]proxy.server:port"
|
2014-04-09 07:57:22 +02:00
|
|
|
|
|
|
|
|
2015-09-24 01:58:20 +02:00
|
|
|
Using Linux Package Managers
|
|
|
|
----------------------------
|
2015-09-08 01:56:10 +02:00
|
|
|
|
2015-09-24 01:58:20 +02:00
|
|
|
See :ref:`pypug:Installing pip/setuptools/wheel with Linux Package Managers` in
|
|
|
|
the `Python Packaging User Guide
|
|
|
|
<https://packaging.python.org/en/latest/current/>`_.
|
2015-09-08 01:56:10 +02:00
|
|
|
|
2015-09-12 05:24:44 +02:00
|
|
|
.. _`Upgrading pip`:
|
|
|
|
|
|
|
|
Upgrading pip
|
|
|
|
-------------
|
2014-03-26 19:05:23 +01:00
|
|
|
|
|
|
|
On Linux or OS X:
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
pip install -U pip
|
|
|
|
|
|
|
|
|
2015-05-09 20:58:55 +02:00
|
|
|
On Windows [5]_:
|
2014-03-26 19:05:23 +01:00
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
python -m pip install -U pip
|
|
|
|
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
Python and OS Compatibility
|
|
|
|
---------------------------
|
2014-03-26 19:05:23 +01:00
|
|
|
|
2015-10-01 15:13:16 +02:00
|
|
|
pip works with CPython versions 2.6, 2.7, 3.3, 3.4, 3.5 and also pypy.
|
2011-03-15 06:43:03 +01:00
|
|
|
|
2016-01-03 23:44:40 +01:00
|
|
|
This means pip works on the latest patch version of each of these minor versions
|
|
|
|
(i.e. 2.6.9 for 2.6, etc).
|
|
|
|
Previous patch versions are supported on a best effort approach.
|
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
pip works on Unix/Linux, OS X, and Windows.
|
2011-04-04 17:37:30 +02:00
|
|
|
|
2011-03-15 06:43:03 +01:00
|
|
|
|
2014-03-26 19:05:23 +01:00
|
|
|
----
|
2013-02-11 07:44:09 +01:00
|
|
|
|
2015-09-08 01:56:10 +02:00
|
|
|
.. [1] For Python 2, see https://docs.python.org/2/installing, and for Python3,
|
|
|
|
see https://docs.python.org/3/installing.
|
2014-12-08 13:15:12 +01:00
|
|
|
|
|
|
|
.. [2] "Secure" in this context means using a modern browser or a
|
2013-08-29 05:43:20 +02:00
|
|
|
tool like `curl` that verifies SSL certificates when downloading from
|
|
|
|
https URLs.
|
|
|
|
|
2014-12-08 13:15:12 +01:00
|
|
|
.. [3] Beginning with pip v1.5.1, ``get-pip.py`` stopped requiring setuptools to
|
2014-02-12 07:13:03 +01:00
|
|
|
be installed first.
|
2011-03-15 06:43:03 +01:00
|
|
|
|
2015-05-09 20:58:55 +02:00
|
|
|
.. [4] The pip developers are considering making ``--user`` the default for all
|
2014-04-10 01:53:52 +02:00
|
|
|
installs, including ``get-pip.py`` installs of pip, but at this time,
|
|
|
|
``--user`` installs for pip itself, should not be considered to be fully
|
|
|
|
tested or endorsed. For discussion, see `Issue 1668
|
|
|
|
<https://github.com/pypa/pip/issues/1668>`_.
|
|
|
|
|
2015-05-09 20:58:55 +02:00
|
|
|
.. [5] https://github.com/pypa/pip/issues/1299
|