pip¶

Do I need to install pip?¶

pip is already installed if you are using Python 2 >=2.7.9 or Python 3 >=3.4 downloaded from python.org or if you are working in a Virtual Environment created by virtualenv or pyvenv. Just make sure to upgrade pip.

Installing with get-pip.py¶

To install pip, securely download get-pip.py. [1]:

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py

Inspect get-pip.py for any malevolence. Then run the following:

python get-pip.py

get-pip.py also installs setuptools [2] and wheel if they are not already. setuptools is required to install source distributions. Both are required in order to build a Wheel Cache (which improves installation speed), although neither are required to install pre-built wheels.

python get-pip.py --no-index --find-links=/local/copies

python get-pip.py --user

python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"

Using Linux Package Managers¶

See Installing pip/setuptools/wheel with Linux Package Managers in the Python Packaging User Guide.

Upgrading pip¶

On Linux or macOS:

pip install -U pip

On Windows [4]:

python -m pip install -U pip

Python and OS Compatibility¶

pip works with CPython versions 2.7, 3.3, 3.4, 3.5, 3.6 and also pypy.

This means pip works on the latest patch version of each of these minor versions. Previous patch versions are supported on a best effort approach.

pip works on Unix/Linux, macOS, and Windows.

Installing Packages¶

pip supports installing from PyPI, version control, local projects, and directly from distribution files.

The most common scenario is to install from PyPI using Requirement Specifiers

$ pip install SomePackage            # latest version
$ pip install SomePackage==1.0.4     # specific version
$ pip install 'SomePackage>=1.0.4'     # minimum version

For more information and examples, see the pip install reference.

Requirements Files¶

“Requirements files” are files containing a list of items to be installed using pip install like so:

pip install -r requirements.txt

Details on the format of the files are here: Requirements File Format.

Logically, a Requirements file is just a list of pip install arguments placed in a file. Note that you should not rely on the items in the file being installed by pip in any particular order.

In practice, there are 4 common uses of Requirements files:

1. Requirements files are used to hold the result from pip freeze for the purpose of achieving repeatable installations. In this case, your requirement file contains a pinned version of everything that was installed when pip freeze was run.

   pip freeze > requirements.txt
   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, but instead simply uses the first specification it finds for a project. E.g. if pkg1 requires pkg3>=1.0 and pkg2 requires pkg3>=1.0,<=2.0, and if pkg1 is resolved first, pip will only use pkg3>=1.0, and could easily end up installing a version of pkg3 that conflicts with the needs of pkg2. To solve this problem, you can place pkg3>=1.0,<=2.0 (i.e. the correct specification) into your requirements file directly along with the other top level requirements. Like so:

   pkg1
   pkg2
   pkg3>=1.0,<=2.0
   

3. Requirements files are used to force pip to install an alternate version of a sub-dependency. For example, suppose ProjectA in your requirements file requires ProjectB, but the latest version (v1.3) has a bug, you can force pip to accept earlier versions like so:

   ProjectA
   ProjectB<1.3
   

4. Requirements files are used to override a dependency with a local patch that lives in version control. For example, suppose a dependency, SomeDependency from PyPI has a bug, and you can’t wait for an upstream fix. You could clone/copy the src, make the fix, and place it in VCS with the tag sometag. You’d reference it in your requirements file with a line like so:

   git+https://myvcs.com/some_dependency@sometag#egg=SomeDependency
   

   If SomeDependency was previously a top-level requirement in your requirements file, then replace that line with the new line. If SomeDependency is a sub-dependency, then add the new line.

It’s important to be clear that pip determines package dependencies using install_requires metadata, not by discovering requirements.txt files embedded in projects.

See also:

• Requirements File Format
• pip freeze
• “setup.py vs requirements.txt” (an article by Donald Stufft)

Constraints Files¶

Constraints files are requirements files that only control which version of a requirement is installed, not whether it is installed or not. Their syntax and contents is nearly identical to Requirements Files. There is one key difference: Including a package in a constraints file does not trigger installation of the package.

Use a constraints file like so:

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 that the “helloworld” package doesn’t work in your environment, so you have a local patched version. Some things you install depend on “helloworld”, and some don’t.

One way to ensure that the patched version is used consistently is to manually audit the dependencies of everything you install, and if “helloworld” is present, write a requirements file to use when installing that thing.

Constraints files offer a better way: write a single constraints file for your organisation and use that everywhere. If the thing being installed requires “helloworld” to be installed, your fixed version specified in your constraints file will be used.

Constraints file support was added in pip 7.1.

Installing from Wheels¶

“Wheel” is a built, archive format that can greatly speed installation compared to building and installing from source archives. For more information, see the Wheel docs , PEP427, and PEP425

Pip prefers Wheels where they are available. To disable this, use the –no-binary flag for pip install.

If no satisfactory wheels are found, pip will default to finding source archives.

To install directly from a wheel archive:

pip install SomePackage-1.0-py2.py3-none-any.whl

For the cases where wheels are not available, pip offers pip wheel as a convenience, to build wheels for all your requirements and dependencies.

pip wheel requires the wheel package to be installed, which provides the “bdist_wheel” setuptools extension that it uses.

To build wheels for your requirements and all their dependencies to a local directory:

pip install wheel
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):

pip install --no-index --find-links=/local/wheels -r requirements.txt

Uninstalling Packages¶

pip is able to uninstall most packages like so:

$ pip uninstall SomePackage

pip also performs an automatic uninstall of an old version of a package before upgrading to a newer version.

For more information and examples, see the pip uninstall reference.

Listing Packages¶

To list installed packages:

$ pip list
docutils (0.9.1)
Jinja2 (2.6)
Pygments (1.5)
Sphinx (1.1.2)

To list outdated packages, and show the latest version available:

$ pip list --outdated
docutils (Current: 0.9.1 Latest: 0.10)
Sphinx (Current: 1.1.2 Latest: 1.1.3)

To show details about an installed package:

$ pip show sphinx
---
Name: Sphinx
Version: 1.1.3
Location: /my/env/lib/pythonx.x/site-packages
Requires: Pygments, Jinja2, docutils

For more information and examples, see the pip list and pip show reference pages.

Searching for Packages¶

pip can search PyPI for packages using the pip search command:

$ pip search "query"

The query will be used to search the names and summaries of all packages.

For more information and examples, see the pip search reference.

Configuration¶

[global]
timeout = 60
index-url = http://download.zope.org/ppix

[global]
timeout = 60

[freeze]
timeout = 10

[install]
ignore-installed = true
no-dependencies = yes

[global]
no-cache-dir = false

[install]
no-compile = no

[global]
find-links =
    http://download.example.com

[install]
find-links =
    http://mirror1.example.com
    http://mirror2.example.com

export PIP_DEFAULT_TIMEOUT=60

pip --default-timeout=60 [...]

export PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"

pip install --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com

Command Completion¶

pip comes with support for command line completion in bash, zsh and fish.

To setup for bash:

$ pip completion --bash >> ~/.profile

To setup for zsh:

$ pip completion --zsh >> ~/.zprofile

To setup for fish:

$ 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 startup file:

eval "`pip completion --bash`"

Installing from local packages¶

In some cases, you may want to install from local packages only, with no traffic to PyPI.

First, download the archives that fulfill your requirements:

$ pip install --download DIR -r requirements.txt

Note that pip install --download will look in your wheel cache first, before trying to download from PyPI. If you’ve never installed your requirements before, you won’t have a wheel cache for those items. In that case, if some of your requirements don’t come as wheels from PyPI, and you want wheels, then run this instead:

$ pip wheel --wheel-dir DIR -r requirements.txt

Then, to install from local only, you’ll be using –find-links and –no-index like so:

$ pip install --no-index --find-links=DIR -r requirements.txt

“Only if needed” Recursive Upgrade¶

pip install --upgrade now has a --upgrade-strategy option which controls how pip handles upgrading of dependencies. There are 2 upgrade strategies supported:

• eager: upgrades all dependencies regardless of whether they still satisfy the new parent requirements
• only-if-needed: upgrades a dependency only if it does not satisfy the new parent requirements

The default strategy is only-if-needed. This was changed in pip 10.0 due to the breaking nature of eager when upgrading conflicting dependencies.

As an historic note, an earlier “fix” for getting the only-if-needed behaviour was:

pip install --upgrade --no-deps SomePackage
pip install SomePackage

A proposal for an upgrade-all command is being considered as a safer alternative to the behaviour of eager upgrading.

User Installs¶

With Python 2.6 came the “user scheme” for installation, which means that all Python distributions support an alternative install location that is specific to a user. The default location for each OS is explained in the python documentation for the site.USER_BASE variable. This mode of installation can be turned on by specifying the –user option to pip install.

Moreover, the “user scheme” can be customized by setting the PYTHONUSERBASE environment variable, which updates the value of site.USER_BASE.

To install “SomePackage” into an environment with site.USER_BASE customized to ‘/myappenv’, do the following:

export PYTHONUSERBASE=/myappenv
pip install --user SomePackage

pip install --user follows four rules:

1. When globally installed packages are on the python path, and they conflict with the installation requirements, they are ignored, and not uninstalled.
2. When globally installed packages are on the python path, and they satisfy the installation requirements, pip does nothing, and reports that requirement is satisfied (similar to how global packages can satisfy requirements when installing packages in a --system-site-packages virtualenv).
3. pip will not perform a --user install in a --no-site-packages virtualenv (i.e. the default kind of virtualenv), due to the user site not being on the python path. The installation would be pointless.
4. In a --system-site-packages virtualenv, pip will not install a package that conflicts with a package in the virtualenv site-packages. The –user installation would lack sys.path precedence and be pointless.

To make the rules clearer, here are some examples:

From within a --no-site-packages virtualenv (i.e. the default kind):

$ pip install --user SomePackage
Can not perform a '--user' install. User site-packages are not visible in this virtualenv.

From within a --system-site-packages virtualenv where SomePackage==0.3 is already installed in the virtualenv:

$ pip install --user SomePackage==0.4
Will not install to the user site because it will lack sys.path precedence

From within a real python, where SomePackage is not installed globally:

$ pip install --user SomePackage
[...]
Successfully installed SomePackage

From within a real python, where SomePackage is installed globally, but is not the latest version:

$ pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)

$ pip install --user --upgrade SomePackage
[...]
Successfully installed SomePackage

From within a real python, where SomePackage is installed globally, and is the latest version:

$ pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)

$ pip install --user --upgrade SomePackage
[...]
Requirement already up-to-date: SomePackage

# force the install
$ pip install --user --ignore-installed SomePackage
[...]
Successfully installed SomePackage

Ensuring Repeatability¶

pip can achieve various levels of repeatability:

SomePackage == 1.2.3
DependencyOfSomePackage == 4.5.6

FooProject == 1.2 --hash=sha256:2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824

$ tempdir=$(mktemp -d /tmp/wheelhouse-XXXXX)
$ pip wheel -r requirements.txt --wheel-dir=$tempdir
$ cwd=`pwd`
$ (cd "$tempdir"; tar -cjvf "$cwd/bundled.tar.bz2" *)

$ tempdir=$(mktemp -d /tmp/wheelhouse-XXXXX)
$ (cd $tempdir; tar -xvf /path/to/bundled.tar.bz2)
$ pip install --force-reinstall --ignore-installed --upgrade --no-index --no-deps $tempdir/*

Pull Requests¶

• Submit Pull Requests against the master branch.
• Provide a good description of what you’re doing and why.
• Provide tests that cover your changes and try to run the tests locally first.

Example. Assuming you set up GitHub account, forked pip repository from https://github.com/pypa/pip to your own page via web interface, and your fork is located at https://github.com/yourname/pip

$ git clone git@github.com:pypa/pip.git
$ cd pip
# ...
$ git diff
$ git add <modified> ...
$ git status
$ git commit

You may reference relevant issues in commit messages (like #1259) to make GitHub link issues and commits together, and with phrase like “fixes #1259” you can even close relevant issues automatically. Now push the changes to your fork:

$ git push git@github.com:yourname/pip.git

Open Pull Requests page at https://github.com/yourname/pip/pulls and click “New pull request”. That’s it.

Automated Testing¶

All pull requests and merges to ‘master’ branch are tested in Travis based on our .travis.yml file.

Usually, a link to your specific travis build appears in pull requests, but if not, you can find it on our travis pull requests page

The only way to trigger Travis to run again for a pull request, is to submit another change to the pull branch.

We also have Jenkins CI that runs regularly for certain python versions on windows and centos.

Running tests¶

OS Requirements: subversion, bazaar, git, and mercurial.

Python Requirements: tox or pytest, virtualenv, scripttest, and mock

Ways to run the tests locally:

$ tox -e py33           # The preferred way to run the tests, can use pyNN to
                        # run for a particular version or leave off the -e to
                        # run for all versions.
$ python setup.py test  # Using the setuptools test plugin
$ py.test               # Using py.test directly
$ tox                   # Using tox against pip's tox.ini

If you are missing one of the VCS tools, you can tell py.test to skip it:

$ py.test -k 'not bzr'
$ py.test -k 'not svn'

Getting Involved¶

The pip project welcomes help in the following ways:

• Making Pull Requests for code, tests, or docs.
• Commenting on open issues and pull requests.
• Helping to answer questions on the mailing list.

If you want to become an official maintainer, start by helping out.

Later, when you think you’re ready, get in touch with one of the maintainers, and they will initiate a vote.

Adding a NEWS Entry¶

The NEWS.rst file is managed using towncrier and all non trivial changes must be accompanied by a news entry.

To add an entry to the news file, first you need to have created an issue describing the change you want to make. A Pull Request itself may function as such, but it is preferred to have a dedicated issue (for example, in case the PR ends up rejected due to code quality reasons).

Once you have an issue or pull request, you take the number and you create a file inside of the news/ directory named after that issue number with an extension of removal, feature, bugfix, or doc. Thus if your issue or PR number is 1234 and this change is fixing a bug, then you would create a file news/1234.bugfix. PRs can span multiple categories by creating multiple files (for instance, if you added a feature and deprecated/removed the old feature at the same time, you would create news/NNNN.feature and news/NNNN.removal). Likewise if a PR touches multiple issues/PRs you may create a file for each of them with the exact same contents and Towncrier will deduplicate them.

The contents of this file are reStructuredText formatted text that will be used as the content of the news file entry. You do not need to reference the issue or PR numbers here as towncrier will automatically add a reference to all of the affected issues when rendering the news file.

A trivial change is anything that does not warrant an entry in the news file. Some examples are: Code refactors that don’t change anything as far as the public is concerned, typo fixes, white space modification, etc. To mark a PR as trivial a contributor simply needs to add a randomly named, empty file to the news/ directory with the extension of .trivial. If you are on a POSIX like operating system, one can be added by running touch news/$(uuidgen).trivial. Core committers may also add a “trivial” label to the PR which will accomplish the same thing.

Upgrading, removing, or adding a new vendored library gets a special mention using a news/<library>.vendor file. This is in addition to any features, bugfixes, or other kinds of news that pulling in this library may have. This uses the library name as the key so that updating the same library twice doesn’t produce two news file entries.

Release Process¶

1. On the current pip master branch, generate a new AUTHORS.txt by running invoke generate.authors and commit the results.
2. On the current pip master branch, make a new commit which bumps the version in pip/__init__.py to the release version and adjust the CHANGES.txt file to reflect the current date.
3. On the current pip master branch, generate a new NEWS.rst by running invoke generate.news and commit the results.
4. Create a signed tag of the master branch of the form X.Y.Z using the command git tag -s X.Y.Z.
5. Checkout the tag using git checkout X.Y.Z and create the distribution files using python setup.py sdist bdist_wheel.
6. Upload the distribution files to PyPI using twine (twine upload -s dist/*). The upload should include GPG signatures of the distribution files.
7. Push all of the changes.
8. Regenerate the get-pip.py script by running invoke generate.installer in the get-pip repository, and committing the results.

Creating a Bugfix Release¶

Sometimes we need to release a bugfix release of the form X.Y.Z+1. In order to create one of these the changes should already be merged into the master branch.

1. Create a new release/X.Y.Z+1 branch off of the X.Y.Z tag using the command git checkout -b release/X.Y.Z+1 X.Y.Z.
2. Cherry pick the fixed commits off of the master branch, fixing any conflicts and moving any changelog entries from the development version’s changelog section to the X.Y.Z+1 section.
3. Push the release/X.Y.Z+1 branch to github and submit a PR for it against the master branch and wait for the tests to run.
4. Once tests run, merge the release/X.Y.Z+1 branch into master, and follow the above release process starting with step 4.

9.0.1 (2016-11-06)¶

• Correct the deprecation message when not specifying a –format so that it uses the correct setting name (format) rather than the incorrect one (list_format). (#4058)
• Fix pip check to check all available distributions and not just the local ones. (#4083)
• Fix a crash on non ASCII characters from lsb_release. (#4062)
• Fix an SyntaxError in an unused module of a vendored dependency. (#4059)
• Fix UNC paths on Windows. (#4064)

9.0.0 (2016-11-02)¶

• BACKWARD INCOMPATIBLE Remove the attempted autodetection of requirement names from URLs, URLs must include a name via #egg=.
• DEPRECATION pip install --egg have been deprecated and will be removed in the future. This “feature” has a long list of drawbacks which break nearly all of pip’s other features in subtle and hard-to-diagnose ways.
• DEPRECATION --default-vcs option. (#4052)
• WARNING pip 9 cache can break forward compatibility with previous pip versions if your package repository allows chunked responses. (#4078)
• Add an --upgrade-strategy option to pip install, to control how dependency upgrades are managed. (#3972)
• Add a pip check command to check installed packages dependencies. (#3750)
• Add option allowing user to abort pip operation if file/directory exists
• Add Appveyor CI
• Uninstall existing packages when performing an editable installation of the same packages. (#1548)
• pip show is less verbose by default. --verbose prints multiline fields. (#3858)
• Add optional column formatting to pip list. (#3651)
• Add --not-required option to pip list, which lists packages that are not dependencies of other packages.
• Fix builds on systems with symlinked /tmp directory for custom builds such as numpy. (#3701)
• Fix regression in pip freeze: when there is more than one git remote, priority is given to the remote named origin. (#3708, #3616).
• Fix crash when calling pip freeze with invalid requirement installed. (#3704, #3681)
• Allow multiple --requirement files in pip freeze. (#3703)
• Implementation of pep-503 data-requires-python. When this field is present for a release link, pip will ignore the download when installing to a Python version that doesn’t satisfy the requirement.
• pip wheel now works on editable packages too (it was only working on editable dependencies before); this allows running pip wheel on the result of pip freeze in presence of editable requirements. (#3695, #3291)
• Load credentials from .netrc files. (#3715, #3569)
• Add --platform, --python-version, --implementation and --abi parameters to pip download. These allow utilities and advanced users to gather distributions for interpreters other than the one pip is being run on. (#3760)
• Skip scanning virtual environments, even when venv/bin/python is a dangling symlink.
• Added pip completion support for the fish shell.
• Fix problems on Windows on Python 2 when username or hostname contains non-ASCII characters. (#3463, #3970, #4000)
• Use git fetch --tags to fetch tags in addition to everything else that is normally fetched; this is necessary in case a git requirement url points to a tag or commit that is not on a branch. (#3791)
• Normalize package names before using in pip show (#3976)
• Raise when Requires-Python do not match the running version and add --ignore-requires-python option as escape hatch. (#3846)
• Report the correct installed version when performing an upgrade in some corner cases. (#2382
• Add -i shorthand for --index flag in pip search.
• Do not optionally load C dependencies in requests. (#1840, #2930, #3024)
• Strip authentication from SVN url prior to passing it to svn. (#3697, #3209)
• Also install in platlib with --target option. (#3694, #3682)
• Restore the ability to use inline comments in requirements files passed to pip freeze. (#3680)

8.1.2 (2016-05-10)¶

• Fix a regression on systems with uninitialized locale. (#3575)
• Use environment markers to filter packages before determining if a required wheel is supported. (#3254)
• Make glibc parsing for manylinux1 support more robust for the variety of glibc versions found in the wild. (#3588)
• Update environment marker support to fully support legacy and PEP 508 style environment markers. (#3624)
• Always use debug logging to the --log file. (#3351)
• Don’t attempt to wrap search results for extremely narrow terminal windows. (#3655)

8.1.1 (2016-03-17)¶

• Fix regression with non-ascii requirement files on Python 2 and add support for encoding headers in requirement files. (#3548, #3547)

8.1.0 (2016-03-05)¶

• Implement PEP 513, which adds support for the manylinux1 platform tag, allowing carefully compiled binary wheels to be installed on compatible Linux platforms.
• Allow wheels which are not specific to a particular Python interpreter but which are specific to a particular platform. (#3202)
• Fixed an issue where call_subprocess would crash trying to print debug data on child process failure. (#3521, #3522)
• Exclude the wheel package from the pip freeze output (like pip and setuptools). (#2989)
• Allow installing modules from a subdirectory of a vcs repository in non-editable mode. (#3217, #3466)
• Make pip wheel and pip download work with vcs urls with subdirectory option. (#3466)
• Show classifiers in pip show.
• Show PEP376 Installer in pip show. (#3517)
• Unhide completion command. (#1810)
• Show latest version number in pip search results. (#1415)
• Decode requirement files according to their BOM if present. (#3485, #2865)
• Fix and deprecate package name detection from url path. (#3523, #3495)
• Correct the behavior where interpreter specific tags (such as cp34) were being used on later versions of the same interpreter instead of only for that specific interpreter. (#3472)
• Fix an issue where pip would erroneously install a 64 bit wheel on a 32 bit Python running on a 64 bit macOS machine.
• Do not assume that all git repositories have an origin remote.
• Correctly display the line to add to a requirements.txt for an URL based dependency when --require-hashes is enabled.

8.0.3 (2016-02-25)¶

• Make install --quiet really quiet. (#3418)
• Fix a bug when removing packages in python 3: disable INI-style parsing of the entry_point.txt file to allow entry point names with colons. (#3434)
• Normalize generated script files path in RECORD files. (#3448)
• Fix bug introduced in 8.0.0 where subcommand output was not shown, even when the user specified -v / --verbose. (#3486)
• Enable python -W with respect to PipDeprecationWarning. (#3455)
• Upgrade distlib to 0.2.2.
• Improved support for Jython when quoting executables in output scripts. (#3467)
• Add a –all option to pip freeze to include usually skipped package (like pip, setuptools and wheel) to the freeze output. (#1610)

8.0.2 (2016-01-21)¶

• Stop attempting to trust the system CA trust store because it’s extremely common for them to be broken, often in incompatible ways. (#3416)

8.0.1 (2016-01-21)¶

• Detect CAPaths in addition to CAFiles on platforms that provide them.
• Installing argparse or wsgiref will no longer warn or error - pip will allow the installation even though it may be useless (since the installed thing will be shadowed by the standard library).
• Upgrading a distutils installed item that is installed outside of a virtual environment, while inside of a virtual environment will no longer warn or error.
• Fix a bug where pre-releases were showing up in pip list --outdated without the --pre flag.
• Switch the SOABI emulation from using RuntimeWarnings to debug logging.
• Rollback the removal of the ability to uninstall distutils installed items until a future date.

8.0.0 (2016-01-19)¶

• BACKWARD INCOMPATIBLE Drop support for Python 3.2.
• BACKWARD INCOMPATIBLE Remove the ability to find any files other than the ones directly linked from the index or find-links pages.
• BACKWARD INCOMPATIBLE Remove the --download-cache which had been deprecated and no-op’d in 6.0.
• BACKWARD INCOMPATIBLE Remove the --log-explicit-levels which had been deprecated in 6.0.
• BACKWARD INCOMPATIBLE Change pip wheel –wheel-dir default path from <cwd>/wheelhouse to <cwd>.
• Deprecate and no-op the --allow-external, --allow-all-external, and --allow-unverified functionality that was added as part of PEP 438. With changes made to the repository protocol made in PEP 470, these options are no longer functional.
• Allow --trusted-host within a requirements file. (#2822)
• Allow --process-dependency-links within a requirements file. (#1274)
• Allow --pre within a requirements file. (#1273)
• Allow repository URLs with secure transports to count as trusted. (E.g., “git+ssh” is okay.) (#2811)
• Implement a top-level pip download command and deprecate pip install --download.
• When uninstalling, look for the case of paths containing symlinked directories (#3141, #3154)
• When installing, if building a wheel fails, clear up the build directory before falling back to a source install. (#3047)
• Fix user directory expansion when HOME=/. Workaround for Python bug http://bugs.python.org/issue14768. (#2996)
• Correct reporting of requirements file line numbers. (#3009, #3125)
• Fixed Exception(IOError) for pip freeze and pip list commands with subversion >= 1.7. (#1062, #3346)
• Provide a spinner showing that progress is happening when installing or building a package via setup.py. This will alleviate concerns that projects with unusually long build times have with pip appearing to stall.
• Include the functionality of peep into pip, allowing hashes to be baked into a requirements file and ensuring that the packages being downloaded match one of those hashes. This is an additional, opt-in security measure that, when used, removes the need to trust the repository.
• Fix a bug causing pip to not select a wheel compiled against an OSX SDK later than what Python itself was compiled against when running on a newer version of OSX.
• Add a new --prefix option for pip install that supports wheels and sdists. (#3252)
• Fixed issue regarding wheel building with setup.py using a different encoding than the system. (#2042)
• Drop PasteScript specific egg_info hack. (#3270)
• Allow combination of pip list options –editable with –outdated/–uptodate. (#933)
• Gives VCS implementations control over saying whether a project is under their control. (#3258)
• Git detection now works when setup.py is not at the Git repo root and when package_dir is used, so pip freeze works in more cases. (#3258)
• Correctly freeze Git develop packages in presence of the &subdirectory option (#3258)
• The detection of editable packages now relies on the presence of .egg-link instead of looking for a VCS, so pip list -e is more reliable. (#3258)
• Add the --prefix flag to pip install which allows specifying a root prefix to use instead of sys.prefix. (#3252)
• Allow duplicate specifications in the case that only the extras differ, and union all specified extras together. (#3198)
• Fix the detection of the user’s current platform on OSX when determining the OSX SDK version. (#3232)
• Prevent the automatically built wheels from mistakenly being used across multiple versions of Python when they may not be correctly configured for that by making the wheel specific to a specific version of Python and specific interpreter. (#3225)
• Emulate the SOABI support in wheels from Python 2.x on Python 2.x as closely as we can with the information available within the interpreter. (#3075)
• Don’t roundtrip to the network when git is pinned to a specific commit hash and that hash already exists locally. (#3066)
• Prefer wheels built against a newer SDK to wheels built against an older SDK on OSX. (#3163)
• Show entry points for projects installed via wheel. (#3122)
• Improve message when an unexisting path is passed to –find-links option. (#2968)
• pip freeze does not add the VCS branch/tag name in the #egg=... fragment anymore. (#3312)
• Warn on installation of editable if the provided #egg=name part does not match the metadata produced by setup.py egg_info. (#3143)
• Add support for .xz files for python versions supporting them (>= 3.3). (#722)

7.1.2 (2015-08-22)¶

• Don’t raise an error if pip is not installed when checking for the latest pip version.

7.1.1 (2015-08-20)¶

• Check that the wheel cache directory is writable before we attempt to write cached files to them.
• Move the pip version check until after any installs have been performed, thus removing the extraneous warning when upgrading pip.
• Added debug logging when using a cached wheel.
• Respect platlib by default on platforms that have it separated from purelib.
• Upgrade packaging to 15.3. - Normalize post-release spellings for rev/r prefixes.
• Upgrade distlib to 0.2.1. - Updated launchers to decode shebangs using UTF-8. This allows non-ASCII pathnames to be correctly handled. - Ensured that the executable written to shebangs is normcased. - Changed ScriptMaker to work better under Jython.
• Upgrade ipaddress to 1.0.13.

7.1.0 (2015-06-30)¶

• Allow constraining versions globally without having to know exactly what will be installed by the pip command. (#2731)
• Accept –no-binary and –only-binary via pip.conf. (#2867)
• Allow --allow-all-external within a requirements file.
• Fixed an issue where --user could not be used when --prefix was used in a distutils configuration file.
• Fixed an issue where the SOABI tags were not correctly being generated on Python 3.5.
• Fixed an issue where we were advising windows users to upgrade by directly executing pip, when that would always fail on Windows.
• Allow ~ to be expanded within a cache directory in all situations.

7.0.3 (2015-06-01)¶

• Fixed a regression where --no-cache-dir would raise an exception. (#2855)

7.0.2 (2015-06-01)¶

• BACKWARD INCOMPATIBLE Revert the change (released in v7.0.0) that required quoting in requirements files around specifiers containing environment markers. (#2841)
• BACKWARD INCOMPATIBLE Revert the accidental introduction of support for options interleaved with requirements, version specifiers etc in requirements files. (#2841)
• Expand ~ in the cache directory when caching wheels. (#2816)
• Use python -m pip instead of pip when recommending an upgrade command to Windows users.

7.0.1 (2015-05-22)¶

• Don’t build and cache wheels for non-editable installations from VCSs.
• Allow --allow-all-external inside of a requirements.txt file, fixing a regression in 7.0.

7.0.0 (2015-05-21)¶

• BACKWARD INCOMPATIBLE Removed the deprecated --mirror, --use-mirrors, and -M options.
• BACKWARD INCOMPATIBLE Removed the deprecated zip and unzip commands.
• BACKWARD INCOMPATIBLE Removed the deprecated --no-install and --no-download options.
• BACKWARD INCOMPATIBLE No longer implicitly support an insecure origin origin, and instead require insecure origins be explicitly trusted with the --trusted-host option.
• BACKWARD INCOMPATIBLE Removed the deprecated link scraping that attempted to parse HTML comments for a specially formatted comment.
• BACKWARD INCOMPATIBLE Requirements in requirements files containing markers must now be quoted due to parser changes. For example, use "SomeProject; python_version < '2.7'", not simply SomeProject; python_version < '2.7' (#2697, #2725)
• get-pip.py now installs the “wheel” package, when it’s not already installed. (#2800)
• Ignores bz2 archives if Python wasn’t compiled with bz2 support. (#497)
• Support --install-option and --global-option per requirement in requirement files. (#2537)
• Build Wheels prior to installing from sdist, caching them in the pip cache directory to speed up subsequent installs. (#2618)
• Allow fine grained control over the use of wheels and source builds. (#2699)
• --no-use-wheel and --use-wheel are deprecated in favour of new options --no-binary and --only-binary. The equivalent of --no-use-wheel is --no-binary=:all:. (#2699)
• The use of --install-option, --global-option or --build-option disable the use of wheels, and the autobuilding of wheels. (#2711, #2677)
• Improve logging when a requirement marker doesn’t match your environment. (#2735)
• Removed the temporary modifications (that began in pip v1.4 when distribute and setuptools merged) that allowed distribute to be considered a conflict to setuptools. pip install -U setuptools will no longer upgrade “distribute” to “setuptools”. Instead, use pip install -U distribute. (#2767)
• Only display a warning to upgrade pip when the newest version is a final release and it is not a post release of the version we already have installed. (#2766)
• Display a warning when attempting to access a repository that uses HTTPS when we don’t have Python compiled with SSL support. (#2761)
• Allowing using extras when installing from a file path without requiring the use of an editable. (#2785)
• Fix an infinite loop when the cache directory is stored on a file system which does not support hard links. (#2796)
• Remove the implicit debug log that was written on every invocation, instead users will need to use --log if they wish to have one. (#2798)

6.1.1 (2015-04-07)¶

• No longer ignore dependencies which have been added to the standard library, instead continue to install them.

6.1.0 (2015-04-07)¶

• Fixes upgrades failing when no potential links were found for dependencies other than the current installation. (#2538, #2502)
• Use a smoother progress bar when the terminal is capable of handling it, otherwise fallback to the original ASCII based progress bar.
• Display much less output when pip install succeeds, because on success, users probably don’t care about all the nitty gritty details of compiling and installing. When pip install fails, display the failed install output once instead of twice, because once is enough. (#2487)
• Upgrade the bundled copy of requests to 2.6.0, fixing CVE-2015-2296.
• Display format of latest package when using pip list --outdated. (#2475)
• Don’t use pywin32 as ctypes should always be available on Windows, using pywin32 prevented uninstallation of pywin32 on Windows. (PR #2467)
• Normalize the --wheel-dir option, expanding out constructs such as ~ when used. (#2441)
• Display a warning when an undefined extra has been requested. (#2142)
• Speed up installing a directory in certain cases by creating a sdist instead of copying the entire directory. (#2535)
• Don’t follow symlinks when uninstalling files (#2552)
• Upgrade the bundled copy of cachecontrol from 0.11.1 to 0.11.2. (#2481, #2595)
• Attempt to more smartly choose the order of installation to try and install dependencies before the projects that depend on them. (#2616)
• Skip trying to install libraries which are part of the standard library. (#2636, #2602)
• Support arch specific wheels that are not tied to a specific Python ABI. (#2561)
• Output warnings and errors to stderr instead of stdout. (#2543)
• Adjust the cache dir file checks to only check ownership if the effective user is root. (#2396)
• Install headers into a per project name directory instead of all of them into the root directory when inside of a virtual environment. (#2421)

6.0.8 (2015-02-04)¶

• Fix an issue where the --download flag would cause pip to no longer use randomized build directories.
• Fix an issue where pip did not properly unquote quoted URLs which contain characters like PEP 440’s epoch separator (!).
• Fix an issue where distutils installed projects were not actually uninstalled and deprecate attempting to uninstall them altogether.
• Retry deleting directories in case a process like an antivirus is holding the directory open temporarily.
• Fix an issue where pip would hide the cursor on Windows but would not reshow it.

6.0.7 (2015-01-28)¶

• Fix a regression where Numpy requires a build path without symlinks to properly build.
• Fix a broken log message when running pip wheel without a requirement.
• Don’t mask network errors while downloading the file as a hash failure.
• Properly create the state file for the pip version check so it only happens once a week.
• Fix an issue where switching between Python 3 and Python 2 would evict cached items.
• Fix a regression where pip would be unable to successfully uninstall a project without a normalized version.

6.0.6 (2015-01-03)¶

• Continue the regression fix from 6.0.5 which was not a complete fix.

6.0.5 (2015-01-03)¶

• Fix a regression with 6.0.4 under Windows where most commands would raise an exception due to Windows not having the os.geteuid() function.

6.0.4 (2015-01-03)¶

• Fix an issue where ANSI escape codes would be used on Windows even though the Windows shell does not support them, causing odd characters to appear with the progress bar.
• Fix an issue where using -v would cause an exception saying TypeError: not all arguments converted during string formatting.
• Fix an issue where using -v with dependency links would cause an exception saying TypeError: 'InstallationCandidate' object is not iterable.
• Fix an issue where upgrading distribute would cause an exception saying TypeError: expected string or buffer.
• Show a warning and disable the use of the cache directory when the cache directory is not owned by the current user, commonly caused by using sudo without the -H flag.
• Update PEP 440 support to handle the latest changes to PEP 440, particularly the changes to >V and <V so that they no longer imply !=V.*.
• Document the default cache directories for each operating system.
• Create the cache directory when the pip version check needs to save to it instead of silently logging an error.
• Fix a regression where the -q flag would not properly suppress the display of the progress bars.

6.0.3 (2014-12-23)¶

• Fix an issue where the implicit version check new in pip 6.0 could cause pip to block for up to 75 seconds if PyPI was not accessible.
• Make --no-index imply --disable-pip-version-check.

6.0.2 (2014-12-23)¶

• Fix an issue where the output saying that a package was installed would report the old version instead of the new version during an upgrade.
• Fix left over merge conflict markers in the documentation.
• Document the backwards incompatible PEP 440 change in the 6.0.0 changelog.

6.0.1 (2014-12-22)¶

• Fix executable file permissions for Wheel files when using the distutils scripts option.
• Fix a confusing error message when an exceptions was raised at certain points in pip’s execution.
• Fix the missing list of versions when a version cannot be found that matches the specifiers.
• Add a warning about the possibly problematic use of > when the given specifier doesn’t match anything.
• Fix an issue where installing from a directory would not copy over certain directories which were being excluded, however some build systems rely on them.

6.0 (2014-12-22)¶

• PROCESS Version numbers are now simply X.Y where the leading 1 has been dropped.
• BACKWARD INCOMPATIBLE Dropped support for Python 3.1.
• BACKWARD INCOMPATIBLE Removed the bundle support which was deprecated in 1.4. (#1806)
• BACKWARD INCOMPATIBLE File lists generated by pip show -f are now rooted at the location reported by show, rather than one (unstated) directory lower. (#1933)
• BACKWARD INCOMPATIBLE The ability to install files over the FTP protocol was accidentally lost in pip 1.5 and it has now been decided to not restore that ability.
• BACKWARD INCOMPATIBLE PEP 440 is now fully implemented, this means that in some cases versions will sort differently or version specifiers will be interpreted differently than previously. The common cases should all function similarly to before.
• DEPRECATION pip install --download-cache and pip wheel --download-cache command line flags have been deprecated and the functionality removed. Since pip now automatically configures and uses it’s internal HTTP cache which supplants the --download-cache the existing options have been made non functional but will still be accepted until their removal in pip v8.0. For more information please see https://pip.pypa.io/en/stable/reference/pip_install.html#caching
• DEPRECATION pip install --build and pip install --no-clean are now NOT deprecated. This reverses the deprecation that occurred in v1.5.3. (#906)
• DEPRECATION Implicitly accessing URLs which point to an origin which is not a secure origin, instead requiring an opt-in for each host using the new --trusted-host flag (pip install --trusted-host example.com foo).
• Allow the new --trusted-host flag to also disable TLS verification for a particular hostname.
• Added a --user flag to pip freeze and pip list to check the user site directory only.
• Silence byte compile errors when installation succeed. (#1873)
• Added a virtualenv-specific configuration file. (#1364)
• Added site-wide configuration files. (1978)
• Added an automatic check to warn if there is an updated version of pip available. (#2049)
• wsgiref and argparse (for >py26) are now excluded from pip list and pip freeze. (#1606, #1369)
• Add --client-cert option for SSL client certificates. (#1424)
• pip show –files was broken for wheel installs. (#1635, #1484)
• install_lib should take precedence when reading distutils config. (#1642, #1641)
• Send Accept-Encoding: identity when downloading files in an attempt to convince some servers who double compress the downloaded file to stop doing so. (#1688)
• Stop breaking when given pip commands in uppercase (#1559, #1725)
• Pip no longer adds duplicate logging consumers, so it won’t create duplicate output when being called multiple times. (#1618, #1723)
• pip wheel now returns an error code if any wheels fail to build. (#1769)
• pip wheel wasn’t building wheels for dependencies of editable requirements. (#1775)
• Allow the use of --no-use-wheel within a requirements file. (#1859)
• Attempt to locate system TLS certificates to use instead of the included CA Bundle if possible. (#1680, #1866)
• Allow use of Zip64 extension in Wheels and other zip files. (#1319, #1868)
• Properly handle an index or –find-links target which has a <base> without a href attribute. (#1101, #1869)
• Properly handle extras when a project is installed via Wheel. (#1885, #1896)
• Added support to respect proxies in pip search. (#1180, #932, #1104, #1902)
• pip install –download works with vcs links. (#798, #1060, #1926)
• Disabled warning about insecure index host when using localhost. Based off of Guy Rozendorn’s work in #1718. (#1456, #1967)
• Allow the use of OS standard user configuration files instead of ones simply based around $HOME. (#2021)
• When installing directly from wheel paths or urls, previous versions were not uninstalled. (#1825, #804, #1838)
• Detect the location of the .egg-info directory by looking for any file located inside of it instead of relying on the record file listing a directory. (#2075, #2076)
• Use a randomized and secure default build directory when possible. (#1964, #1935, #676, #2122, CVE-2014-8991)
• Support environment markers in requirements.txt files. (#1433, #2134)
• Automatically retry failed HTTP requests by default. (#1444, #2147)
• Handle HTML Encoding better using a method that is more similar to how browsers handle it. (#1100, #1874)
• Reduce the verbosity of the pip command by default. (#2175, #2177, #2178)
• Fixed #2031 - Respect sys.executable on OSX when installing from Wheels.
• Display the entire URL of the file that is being downloaded when downloading from a non PyPI repository. (#2183)
• Support setuptools style environment markers in a source distribution. (#2153)

1.5.6 (2014-05-16)¶

• Upgrade requests to 2.3.0 to fix an issue with proxies on Python 3.4.1. (#1821)

1.5.5 (2014-05-03)¶

• Uninstall issues on debianized pypy, specifically issues with setuptools upgrades. (#1632, #1743)
• Update documentation to point at https://bootstrap.pypa.io/get-pip.py for bootstrapping pip.
• Update docs to point to https://pip.pypa.io/
• Upgrade the bundled projects (distlib==0.1.8, html5lib==1.0b3, six==1.6.1, colorama==0.3.1, setuptools==3.4.4).

1.5.4 (2014-02-21)¶

• Correct deprecation warning for pip install --build to only notify when the –build value is different than the default.

1.5.3 (2014-02-20)¶

• DEPRECATION pip install --build and pip install --no-clean are now deprecated. (#906)
• Fixed being unable to download directly from wheel paths/urls, and when wheel downloads did occur using requirement specifiers, dependencies weren’t downloaded. (#1112, #1527)
• pip wheel was not downloading wheels that already existed. (#1320, #1524)
• pip install --download was failing using local --find-links. (#1111, #1524)
• Workaround for Python bug http://bugs.python.org/issue20053. (#1544)
• Don’t pass a unicode __file__ to setup.py on Python 2.x. (#1583)
• Verify that the Wheel version is compatible with this pip. (#1569)

1.5.2 (2014-01-26)¶

• Upgraded the vendored pkg_resources and _markerlib to setuptools 2.1.
• Fixed an error that prevented accessing PyPI when pyopenssl, ndg-httpsclient, and pyasn1 are installed.
• Fixed an issue that caused trailing comments to be incorrectly included as part of the URL in a requirements file.

1.5.1 (2014-01-20)¶

• pip now only requires setuptools (any setuptools, not a certain version) when installing distributions from src (i.e. not from wheel). (#1434)
• get-pip.py now installs setuptools, when it’s not already installed. (#1475)
• Don’t decode downloaded files that have a Content-Encoding header. (#1435)
• Fix to correctly parse wheel filenames with single digit versions. (#1445)
• If –allow-unverified is used assume it also means –allow-external. (#1457)

1.5 (2014-01-01)¶

• BACKWARD INCOMPATIBLE pip no longer supports the --use-mirrors, -M, and --mirrors flags. The mirroring support has been removed. In order to use a mirror specify it as the primary index with -i or --index-url, or as an additional index with --extra-index-url. (#1098, CVE-2013-5123)
• BACKWARD INCOMPATIBLE pip no longer will scrape insecure external urls by default nor will it install externally hosted files by default. Users may opt into installing externally hosted or insecure files or urls using --allow-external PROJECT and --allow-unverified PROJECT. (#1055)
• BACKWARD INCOMPATIBLE pip no longer respects dependency links by default. Users may opt into respecting them again using --process-dependency-links.
• DEPRECATION pip install --no-install and pip install --no-download are now formally deprecated. See #906 for discussion on possible alternatives, or lack thereof, in future releases.
• DEPRECATION pip zip and pip unzip are now formally deprecated.
• pip will now install Mac OSX platform wheels from PyPI. (PR #1278)
• pip now generates the appropriate platform-specific console scripts when installing wheels. (#1251)
• Pip now confirms a wheel is supported when installing directly from a path or url. (#1315)
• --ignore-installed now behaves again as designed, after it was unintentionally broke in v0.8.3 when fixing #14. (#1097, #1352)
• Fixed a bug where global scripts were being removed when uninstalling –user installed packages. (#1353)
• --user wasn’t being respected when installing scripts from wheels. (#1163, #1176)
• Assume ‘_’ means ‘-‘ in versions from wheel filenames. (#1150, #1158)
• Error when using –log with a failed install. (#219, #1205)
• Fixed logging being buffered and choppy in Python 3. (#1131)
• Don’t ignore –timeout. (#70, #1202)
• Fixed an error when setting PIP_EXISTS_ACTION. (#772, #1201)
• Added colors to the logging output in order to draw attention to important warnings and errors. (#1109)
• Added warnings when using an insecure index, find-link, or dependency link. (#1121)
• Added support for installing packages from a subdirectory using the subdirectory editable option. (#1082)
• Fixed “TypeError: bad operand type for unary” in some cases when installing wheels using –find-links. (#1192, #1218)
• Archive contents are now written based on system defaults and umask (i.e. permissions are not preserved), except that regular files with any execute permissions have the equivalent of “chmod +x” applied after being written. (#1133, #317, #1146)
• PreviousBuildDirError now returns a non-zero exit code and prevents the previous build dir from being cleaned in all cases. (#1162)
• Renamed –allow-insecure to –allow-unverified, however the old name will continue to work for a period of time. (#1257)
• Fixed an error when installing local projects with symlinks in Python 3. (#1006, #1311)
• The previously hidden --log-file option, is now shown as a general option. (#1316)

1.4.1 (2013-08-07)¶

• New Signing Key Release 1.4.1 is using a different key than normal with fingerprint: 7C6B 7C5D 5E2B 6356 A926 F04F 6E3C BCE9 3372 DCFA
• Fixed issues with installing from pybundle files. (#1116)
• Fixed error when sysconfig module throws an exception. (#1095)
• Don’t ignore already installed pre-releases. (#1076)
• Fixes related to upgrading setuptools. (#1092)
• Fixes so that –download works with wheel archives. (#1113)
• Fixes related to recognizing and cleaning global build dirs. (#1080)

1.4 (2013-07-23)¶

• BACKWARD INCOMPATIBLE pip now only installs stable versions by default, and offers a new --pre option to also find pre-release and development versions. (#834)
• BACKWARD INCOMPATIBLE Dropped support for Python 2.5. The minimum supported Python version for pip 1.4 is Python 2.6.
• Added support for installing and building wheel archives. Thanks Daniel Holth, Marcus Smith, Paul Moore, and Michele Lacchia (#845)
• Applied security patch to pip’s ssl support related to certificate DNS wildcard matching (http://bugs.python.org/issue17980).
• To satisfy pip’s setuptools requirement, pip now recommends setuptools>=0.8, not distribute. setuptools and distribute are now merged into one project called ‘setuptools’. (#1003)
• pip will now warn when installing a file that is either hosted externally to the index or cannot be verified with a hash. In the future pip will default to not installing them and will require the flags –allow-external NAME, and –allow-insecure NAME respectively. (#985)
• If an already-downloaded or cached file has a bad hash, re-download it rather than erroring out. (#963)
• pip bundle and support for installing from pybundle files is now considered deprecated and will be removed in pip v1.5.
• Fix a number of isses related to cleaning up and not reusing build directories. (#413, #709, #634, #602, #939, #865, #948)
• Added a User Agent so that pip is identifiable in logs. (#901)
• Added ssl and –user support to get-pip.py. Thanks Gabriel de Perthuis. (#895)
• Fixed the proxy support, which was broken in pip 1.3.x (#840)
• Fixed pip failing when server does not send content-type header. Thanks Hugo Lopes Tavares and Kelsey Hightower. (#32, #872)
• “Vendorized” distlib as pip.vendor.distlib (https://distlib.readthedocs.io/).
• Fixed git VCS backend with git 1.8.3. (#967)

1.3.1 (2013-03-08)¶

• Fixed a major backward incompatible change of parsing URLs to externally hosted packages that got accidentally included in 1.3.

1.3 (2013-03-07)¶

• SSL Cert Verification; Make https the default for PyPI access. Thanks James Cleveland, Giovanni Bajo, Marcus Smith and many others. (#791, CVE-2013-1629)
• Added “pip list” for listing installed packages and the latest version available. Thanks Rafael Caricio, Miguel Araujo, Dmitry Gladkov. (#752)
• Fixed security issues with pip’s use of temp build directories. Thanks David (d1b) and Thomas Guttler. (#780, CVE-2013-1888)
• Improvements to sphinx docs and cli help. (#773)
• Fixed an issue dealing with macOS temp dir handling, which was causing global NumPy installs to fail. (#707, #768)
• Split help output into general vs command-specific option groups. Thanks Georgi Valkov. (#744, #721)
• Fixed dependency resolution when installing from archives with uppercase project names. (#724)
• Fixed problem where re-installs always occurred when using file:// find-links. (#683, #702)
• “pip install -v” now shows the full download url, not just the archive name. Thanks Marc Abramowitz (#687)
• Fix to prevent unnecessary PyPI redirects. Thanks Alex Gronholm (#695)
• Fixed an install failure under Python 3 when the same version of a package is found under 2 different URLs. Thanks Paul Moore (#670, #671)
• Fix git submodule recursive updates. Thanks Roey Berman. (#674)
• Explicitly ignore rel=’download’ links while looking for html pages. Thanks Maxime R. (#677)
• –user/–upgrade install options now work together. Thanks ‘eevee’ for discovering the problem. (#705)
• Added check in install --download to prevent re-downloading if the target file already exists. Thanks Andrey Bulgakov. (#669)
• Added support for bare paths (including relative paths) as argument to –find-links. Thanks Paul Moore for draft patch.
• Added support for –no-index in requirements files.
• Added “pip show” command to get information about an installed package. Thanks Kelsey Hightower and Rafael Caricio. (#131)
• Added –root option for “pip install” to specify root directory. Behaves like the same option in distutils but also plays nice with pip’s egg-info. Thanks Przemek Wrzos. (#253, #693)

1.2.1 (2012-09-06)¶

• Fixed a regression introduced in 1.2 about raising an exception when not finding any files to uninstall in the current environment. Thanks for the fix, Marcus Smith.

1.2 (2012-09-01)¶

• Dropped support for Python 2.4 The minimum supported Python version is now Python 2.5.
• Fixed pypi mirror support being broken on some DNS responses. Thanks philwhin. (#605)
• Fixed pip uninstall removing files it didn’t install. Thanks pjdelport. (#355)
• Fixed a number of issues related to improving support for the user installation scheme. Thanks Marcus Smith. (#493, #494, #440, #573)
• Write failure log to temp file if default location is not writable. Thanks andreigc.
• Pull in submodules for git editable checkouts. Thanks Hsiaoming Yang and Markus Hametner. (#289, #421)
• Use a temporary directory as the default build location outside of a virtualenv. Thanks Ben Rosser. (#339, #381)
• Added support for specifying extras with local editables. Thanks Nick Stenning.
• Added --egg flag to request egg-style rather than flat installation. Thanks Kamal Bin Mustafa. (#3)
• Prevent e.g. gmpy2-2.0.tar.gz from matching a request to pip install gmpy; sdist filename must begin with full project name followed by a dash. Thanks casevh for the report. (#510)
• Allow package URLS to have querystrings. Thanks W. Trevor King. (#504)
• pip freeze now falls back to non-editable format rather than blowing up if it can’t determine the origin repository of an editable. Thanks Rory McCann. (#58)
• Added a __main__.py file to enable python -m pip on Python versions that support it. Thanks Alexey Luchko.
• Fixed upgrading from VCS url of project that does exist on index. Thanks Andrew Knapp for the report. (#487)
• Fix upgrade from VCS url of project with no distribution on index. Thanks Andrew Knapp for the report. (#486)
• Add a clearer error message on a malformed VCS url. Thanks Thomas Fenzl. (#427)
• Added support for using any of the built in guaranteed algorithms in hashlib as a checksum hash.
• Raise an exception if current working directory can’t be found or accessed. (#321)
• Removed special casing of the user directory and use the Python default instead. (#82)
• Only warn about version conflicts if there is actually one. This re-enables using ==dev in requirements files. (#436)
• Moved tests to be run on Travis CI: http://travis-ci.org/pypa/pip
• Added a better help formatter.

1.1 (2012-02-16)¶

• Don’t crash when a package’s setup.py emits UTF-8 and then fails. Thanks Marc Abramowitz. (#326)
• Added --target option for installing directly to arbitrary directory. Thanks Stavros Korokithakis.
• Added support for authentication with Subversion repositories. Thanks Qiangning Hong.
• --download now downloads dependencies as well. Thanks Qiangning Hong. (#315)
• Errors from subprocesses will display the current working directory. Thanks Antti Kaihola.
• Fixed compatibility with Subversion 1.7. Thanks Qiangning Hong. Note that setuptools remains incompatible with Subversion 1.7; to get the benefits of pip’s support you must use Distribute rather than setuptools. (#369)
• Ignore py2app-generated macOS mpkg zip files in finder. Thanks Rene Dudfield. (#57)
• Log to ~/Library/Logs/ by default on macOS framework installs. Thanks Dan Callahan for report and patch. (#182)
• Understand version tags without minor version (“py3”) in sdist filenames. Thanks Stuart Andrews for report and Olivier Girardot for patch. (#310)
• Pip now supports optionally installing setuptools “extras” dependencies; e.g. “pip install Paste[openid]”. Thanks Matt Maker and Olivier Girardot. (#7)
• freeze no longer borks on requirements files with –index-url or –find-links. Thanks Herbert Pfennig. (#391)
• Handle symlinks properly. Thanks lebedov for the patch. (#288)
• pip install -U no longer reinstalls the same versions of packages. Thanks iguananaut for the pull request. (#49)
• Removed -E/--environment option and PIP_RESPECT_VIRTUALENV; both use a restart-in-venv mechanism that’s broken, and neither one is useful since every virtualenv now has pip inside it. Replace pip -E path/to/venv install Foo with virtualenv path/to/venv && path/to/venv/pip install Foo.
• Fixed pip throwing an IndexError when it calls scraped_rel_links. (#366)
• pip search should set and return a useful shell status code. (#22)
• Added global --exists-action command line option to easier script file exists conflicts, e.g. from editable requirements from VCS that have a changed repo URL. (#351, #365)

1.0.2 (2011-07-16)¶

• Fixed docs issues.
• Reinstall a package when using the install -I option. (#295)
• Finds a Git tag pointing to same commit as origin/master. (#283)
• Use absolute path for path to docs in setup.py. (#279)
• Correctly handle exceptions on Python3. (#314)
• Correctly parse --editable lines in requirements files. (#320)

1.0.1 (2011-04-30)¶

• Start to use git-flow.
• find_command should not raise AttributeError. (#274)
• Respect Content-Disposition header. Thanks Bradley Ayers. (#273)
• pathext handling on Windows. (#233)
• svn+svn protocol. (#252)
• multiple CLI searches. (#44)
• Current working directory when running setup.py clean. (#266)

1.0 (2011-04-04)¶

• Added Python 3 support! Huge thanks to Vinay Sajip, Vitaly Babiy, Kelsey Hightower, and Alex Gronholm, among others.

• Download progress only shown on a real TTY. Thanks Alex Morega.

• Fixed finding of VCS binaries to not be fooled by same-named directories. Thanks Alex Morega.

• Fixed uninstall of packages from system Python for users of Debian/Ubuntu python-setuptools package (workaround until fixed in Debian and Ubuntu).

• Added get-pip.py installer. Simply download and execute it, using the Python interpreter of your choice:

  $ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
  $ python get-pip.py
  

  This may have to be run as root.

  Note

  Make sure you have distribute installed before using the installer!

0.8.3¶

• Moved main repository to Github: https://github.com/pypa/pip
• Transferred primary maintenance from Ian to Jannis Leidel, Carl Meyer, Brian Rosner
• Fixed no uninstall-on-upgrade with URL package. Thanks Oliver Tonnhofer. (#14)
• Fixed egg name not properly resolving. Thanks Igor Sobreira. (#163)
• Fixed Non-alphabetical installation of requirements. Thanks Igor Sobreira. (#178)
• Fixed documentation mentions –index instead of –index-url. Thanks Kelsey Hightower (#199)
• rmtree undefined in mercurial.py. Thanks Kelsey Hightower. (#204)
• Fixed bug in Git vcs backend that would break during reinstallation.
• Fixed bug in Mercurial vcs backend related to pip freeze and branch/tag resolution.
• Fixed bug in version string parsing related to the suffix “-dev”.

0.8.2¶

• Avoid redundant unpacking of bundles (from pwaller)

• Fixed checking out the correct tag/branch/commit when updating an editable Git requirement. (#32, #150, #161)

• Added ability to install version control requirements without making them editable, e.g.:

  pip install git+https://github.com/pypa/pip/
  

  (#49)

• Correctly locate build and source directory on macOS. (#175)

• Added git+https:// scheme to Git VCS backend.

0.8.1¶

• Added global –user flag as shortcut for –install-option=”–user”. From Ronny Pfannschmidt.
• Added support for PyPI mirrors as defined in PEP 381, from Jannis Leidel.
• Fixed git revisions being ignored. Thanks John-Scott Atlakson. (#138)
• Fixed initial editable install of github package from a tag failing. Thanks John-Scott Atlakson. (#95)
• Fixed installing if a directory in cwd has the same name as the package you’re installing. (#107)
• –install-option=”–prefix=~/.local” ignored with -e. Thanks Ronny Pfannschmidt and Wil Tan. (#39)

0.8¶

• Track which build/ directories pip creates, never remove directories it doesn’t create. From Hugo Lopes Tavares.
• Pip now accepts file:// index URLs. Thanks Dave Abrahams.
• Various cleanup to make test-running more consistent and less fragile. Thanks Dave Abrahams.
• Real Windows support (with passing tests). Thanks Dave Abrahams.
• pip-2.7 etc. scripts are created (Python-version specific scripts)
• contrib/build-standalone script creates a runnable .zip form of pip, from Jannis Leidel
• Editable git repos are updated when reinstalled
• Fix problem with --editable when multiple .egg-info/ directories are found.
• A number of VCS-related fixes for pip freeze, from Hugo Lopes Tavares.
• Significant test framework changes, from Hugo Lopes Tavares.

0.7.2¶

• Set zip_safe=False to avoid problems some people are encountering where pip is installed as a zip file.

0.7.1¶

• Fixed opening of logfile with no directory name. Thanks Alexandre Conrad.
• Temporary files are consistently cleaned up, especially after installing bundles, also from Alex Conrad.
• Tests now require at least ScriptTest 1.0.3.

0.7¶

• Fixed uninstallation on Windows
• Added pip search command.
• Tab-complete names of installed distributions for pip uninstall.
• Support tab-completion when there is a global-option before the subcommand.
• Install header files in standard (scheme-default) location when installing outside a virtualenv. Install them to a slightly more consistent non-standard location inside a virtualenv (since the standard location is a non-writable symlink to the global location).
• pip now logs to a central location by default (instead of creating pip-log.txt all over the place) and constantly overwrites the file in question. On Unix and macOS this is '$HOME/.pip/pip.log' and on Windows it’s '%HOME%\\pip\\pip.log'. You are still able to override this location with the $PIP_LOG_FILE environment variable. For a complete (appended) logfile use the separate '--log' command line option.
• Fixed an issue with Git that left an editable package as a checkout of a remote branch, even if the default behaviour would have been fine, too.
• Fixed installing from a Git tag with older versions of Git.
• Expand “~” in logfile and download cache paths.
• Speed up installing from Mercurial repositories by cloning without updating the working copy multiple times.
• Fixed installing directly from directories (e.g. pip install path/to/dir/).
• Fixed installing editable packages with svn+ssh URLs.
• Don’t print unwanted debug information when running the freeze command.
• Create log file directory automatically. Thanks Alexandre Conrad.
• Make test suite easier to run successfully. Thanks Dave Abrahams.
• Fixed “pip install .” and “pip install ..”; better error for directory without setup.py. Thanks Alexandre Conrad.
• Support Debian/Ubuntu “dist-packages” in zip command. Thanks duckx.
• Fix relative –src folder. Thanks Simon Cross.
• Handle missing VCS with an error message. Thanks Alexandre Conrad.
• Added –no-download option to install; pairs with –no-install to separate download and installation into two steps. Thanks Simon Cross.
• Fix uninstalling from requirements file containing -f, -i, or –extra-index-url.
• Leftover build directories are now removed. Thanks Alexandre Conrad.

0.6.3¶

• Fixed import error on Windows with regard to the backwards compatibility package

0.6.2¶

• Fixed uninstall when /tmp is on a different filesystem.
• Fixed uninstallation of distributions with namespace packages.

0.6.1¶

• Added support for the https and http-static schemes to the Mercurial and ftp scheme to the Bazaar backend.
• Fixed uninstallation of scripts installed with easy_install.
• Fixed an issue in the package finder that could result in an infinite loop while looking for links.
• Fixed issue with pip bundle and local files (which weren’t being copied into the bundle), from Whit Morriss.

0.6¶

• Add pip uninstall and uninstall-before upgrade (from Carl Meyer).
• Extended configurability with config files and environment variables.
• Allow packages to be upgraded, e.g., pip install Package==0.1 then pip install Package==0.2.
• Allow installing/upgrading to Package==dev (fix “Source version does not match target version” errors).
• Added command and option completion for bash and zsh.
• Extended integration with virtualenv by providing an option to automatically use an active virtualenv and an option to warn if no active virtualenv is found.
• Fixed a bug with pip install –download and editable packages, where directories were being set with 0000 permissions, now defaults to 755.
• Fixed uninstallation of easy_installed console_scripts.
• Fixed uninstallation on macOS Framework layout installs
• Fixed bug preventing uninstall of editables with source outside venv.
• Creates download cache directory if not existing.

0.5.1¶

• Fixed a couple little bugs, with git and with extensions.

0.5¶

• Added ability to override the default log file name (pip-log.txt) with the environmental variable $PIP_LOG_FILE.
• Made the freeze command print installed packages to stdout instead of writing them to a file. Use simple redirection (e.g. pip freeze > stable-req.txt) to get a file with requirements.
• Fixed problem with freezing editable packages from a Git repository.
• Added support for base URLs using <base href='...'> when parsing HTML pages.
• Fixed installing of non-editable packages from version control systems.
• Fixed issue with Bazaar’s bzr+ssh scheme.
• Added –download-dir option to the install command to retrieve package archives. If given an editable package it will create an archive of it.
• Added ability to pass local file and directory paths to --find-links, e.g. --find-links=file:///path/to/my/private/archive
• Reduced the amount of console log messages when fetching a page to find a distribution was problematic. The full messages can be found in pip-log.txt.
• Added --no-deps option to install ignore package dependencies
• Added --no-index option to ignore the package index (PyPI) temporarily
• Fixed installing editable packages from Git branches.
• Fixes freezing of editable packages from Mercurial repositories.
• Fixed handling read-only attributes of build files, e.g. of Subversion and Bazaar on Windows.
• When downloading a file from a redirect, use the redirected location’s extension to guess the compression (happens specifically when redirecting to a bitbucket.org tip.gz file).
• Editable freeze URLs now always use revision hash/id rather than tip or branch names which could move.
• Fixed comparison of repo URLs so incidental differences such as presence/absence of final slashes or quoted/unquoted special characters don’t trigger “ignore/switch/wipe/backup” choice.
• Fixed handling of attempt to checkout editable install to a non-empty, non-repo directory.

0.4¶

• Make -e work better with local hg repositories
• Construct PyPI URLs the exact way easy_install constructs URLs (you might notice this if you use a custom index that is slash-sensitive).
• Improvements on Windows (from Ionel Maries Cristian).
• Fixed problem with not being able to install private git repositories.
• Make pip zip zip all its arguments, not just the first.
• Fix some filename issues on Windows.
• Allow the -i and --extra-index-url options in requirements files.
• Fix the way bundle components are unpacked and moved around, to make bundles work.
• Adds -s option to allow the access to the global site-packages if a virtualenv is to be created.
• Fixed support for Subversion 1.6.

0.3.1¶

• Improved virtualenv restart and various path/cleanup problems on win32.
• Fixed a regression with installing from svn repositories (when not using -e).
• Fixes when installing editable packages that put their source in a subdirectory (like src/).
• Improve pip -h

0.3¶

• Added support for editable packages created from Git, Mercurial and Bazaar repositories and ability to freeze them. Refactored support for version control systems.
• Do not use sys.exit() from inside the code, instead use a return. This will make it easier to invoke programmatically.
• Put the install record in Package.egg-info/installed-files.txt (previously they went in site-packages/install-record-Package.txt).
• Fix a problem with pip freeze not including -e svn+ when an svn structure is peculiar.
• Allow pip -E to work with a virtualenv that uses a different version of Python than the parent environment.
• Fixed Win32 virtualenv (-E) option.
• Search the links passed in with -f for packages.
• Detect zip files, even when the file doesn’t have a .zip extension and it is served with the wrong Content-Type.
• Installing editable from existing source now works, like pip install -e some/path/ will install the package in some/path/. Most importantly, anything that package requires will also be installed by pip.
• Add a --path option to pip un/zip, so you can avoid zipping files that are outside of where you expect.
• Add --simulate option to pip zip.

0.2.1¶

• Fixed small problem that prevented using pip.py without actually installing pip.
• Fixed --upgrade, which would download and appear to install upgraded packages, but actually just reinstall the existing package.
• Fixed Windows problem with putting the install record in the right place, and generating the pip script with Setuptools.
• Download links that include embedded spaces or other unsafe characters (those characters get %-encoded).
• Fixed use of URLs in requirement files, and problems with some blank lines.
• Turn some tar file errors into warnings.

0.2¶

• Renamed to pip, and to install you now do pip install PACKAGE
• Added command pip zip PACKAGE and pip unzip PACKAGE. This is particularly intended for Google App Engine to manage libraries to stay under the 1000-file limit.
• Some fixes to bundles, especially editable packages and when creating a bundle using unnamed packages (like just an svn repository without #egg=Package).

0.1.4¶

• Added an option --install-option to pass options to pass arguments to setup.py install
• .svn/ directories are no longer included in bundles, as these directories are specific to a version of svn – if you build a bundle on a system with svn 1.5, you can’t use the checkout on a system with svn 1.4. Instead a file svn-checkout.txt is included that notes the original location and revision, and the command you can use to turn it back into an svn checkout. (Probably unpacking the bundle should, maybe optionally, recreate this information – but that is not currently implemented, and it would require network access.)
• Avoid ambiguities over project name case, where for instance MyPackage and mypackage would be considered different packages. This in particular caused problems on Macs, where MyPackage/ and mypackage/ are the same directory.
• Added support for an environmental variable $PIP_DOWNLOAD_CACHE which will cache package downloads, so future installations won’t require large downloads. Network access is still required, but just some downloads will be avoided when using this.

0.1.3¶

• Always use svn checkout (not export) so that tag_svn_revision settings give the revision of the package.
• Don’t update checkouts that came from .pybundle files.

0.1.2¶

• Improve error text when there are errors fetching HTML pages when seeking packages.
• Improve bundles: include empty directories, make them work with editable packages.
• If you use -E env and the environment env/ doesn’t exist, a new virtual environment will be created.
• Fix dependency_links for finding packages.

0.1.1¶

• Fixed a NameError exception when running pip outside of a virtualenv environment.
• Added HTTP proxy support (from Prabhu Ramachandran)
• Fixed use of hashlib.md5 on python2.5+ (also from Prabhu Ramachandran)

0.1¶

• Initial release