Merge branch 'master' into pep518

Author: takluyver

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to pip
+
+Thank you for your interest in contributing to pip! There are many ways to
+contribute, and we appreciate all of them.
+
+As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
+
+[coc]: https://www.pypa.io/en/latest/code-of-conduct/
+
+
+## Bot Commands
+
+We have a bot monitoring the [pypa/pip](https://github.com/pypa/pip) repository
+to help manage the state of issues and pull requests to keep everything running
+smoothly. Each command given to the bot should be on its own line and is
+generally case sensitive. Multiple commands may be listed in a single comment
+(but they must each be on their own line) and the comments may also include
+other, non command content.
+
+Command | Who can run it | Description
+--- | --- | ---
+`/request-review` | anyone | Dismisses all of the current reviews on a pull request, making it appear back in the review queue.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+<!---
+Thank you for your soon to be pull request. Before you submit this, please
+double check to make sure that you've added a news file fragment. In pip we
+generate our NEWS.rst from multiple news fragment files, and all pull requests
+require either a news file fragment or a marker to indicate they don't require
+one.
+
+To read more about adding a news file fragment for your PR, please check out
+our documentation at: https://pip.pypa.io/en/latest/development/#adding-a-news-entry
+-->

AUTHORS.txt

@@ -172,6 +172,7 @@ Lincoln de Sousa <lincoln@comum.org>
 Lipis <lipiridis@gmail.com>
 Ludovic Gasc <gmludo@gmail.com>
 Luke Macken <lmacken@redhat.com>
+Luo Jiebin <luo.jiebin@foxmail.com>
 Marc Abramowitz <marc@marc-abramowitz.com>
 Marc Tamlyn <marc.tamlyn@gmail.com>
 Marcus Smith <qwcode@gmail.com>

docs/conf.py

@@ -156,7 +156,7 @@
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-html_use_smartypants = False
+# html_use_smartypants = False
 
 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {}

docs/installing.rst

@@ -21,7 +21,7 @@ Installing with get-pip.py
 --------------------------
 
 To install pip, securely download `get-pip.py
-<https://bootstrap.pypa.io/get-pip.py>`_. [2]_
+<https://bootstrap.pypa.io/get-pip.py>`_. [1]_
 
 Then run the following:
 
@@ -36,7 +36,7 @@ Then run the following:
    system or another package manager. get-pip.py does not coordinate with
    those tools, and may leave your system in an inconsistent state.
 
-get-pip.py will also install :ref:`pypug:setuptools` [3]_ and :ref:`pypug:wheel`,
+get-pip.py will also install :ref:`pypug:setuptools` [2]_ and :ref:`pypug:wheel`,
 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
@@ -70,13 +70,13 @@ Install from local copies of pip and setuptools::
 
   python get-pip.py --no-index --find-links=/local/copies
 
-Install to the user site [4]_::
+Install to the user site [3]_::
 
   python get-pip.py --user
 
 Install behind a proxy::
 
-  python get-pip.py --proxy="[user:passwd@]proxy.server:port"
+  python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
 
 
 Using Linux Package Managers
@@ -98,7 +98,7 @@ On Linux or macOS:
  pip install -U pip
 
 
-On Windows [5]_:
+On Windows [4]_:
 
 ::
 
@@ -118,20 +118,17 @@ pip works on Unix/Linux, macOS, and Windows.
 
 ----
 
-.. [1] For Python 2, see https://docs.python.org/2/installing, and for Python3,
-       see https://docs.python.org/3/installing.
-
-.. [2] "Secure" in this context means using a modern browser or a
+.. [1] "Secure" in this context means using a modern browser or a
        tool like `curl` that verifies SSL certificates when downloading from
        https URLs.
 
-.. [3] Beginning with pip v1.5.1, ``get-pip.py`` stopped requiring setuptools to
+.. [2] Beginning with pip v1.5.1, ``get-pip.py`` stopped requiring setuptools to
        be installed first.
 
-.. [4] The pip developers are considering making ``--user`` the default for all
+.. [3] The pip developers are considering making ``--user`` the default for all
        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>`_.
 
-.. [5] https://github.com/pypa/pip/issues/1299
+.. [4] https://github.com/pypa/pip/issues/1299

docs/reference/pip_install.rst

@@ -325,6 +325,9 @@ the :ref:`--editable <install_--editable>` option) or not.
   already installed, the VCS source will not overwrite it without an `--upgrade`
   flag. VCS requirements pin the package version (specified in the `setup.py`
   file) of the target commit, not necessarily the commit itself.
+* The :ref:`pip freeze` subcommand will record the VCS requirement specifier
+  (referencing a specific commit) if and only if the install is done using the
+  editable option.
 
 The "project name" component of the url suffix "egg=<project name>-<version>"
 is used by pip in its dependency logic to identify the project prior
@@ -509,7 +512,7 @@ building a new wheel. Note that this means when a package has both optional
 C extensions and builds `py` tagged wheels when the C extension can't be built
 that pip will not attempt to build a better wheel for Pythons that would have
 supported it, once any generic wheel is built. To correct this, make sure that
-the wheels are built with Python specific tags - e.g. pp on Pypy.
+the wheels are built with Python specific tags - e.g. pp on PyPy.
 
 When no wheels are found for an sdist, pip will attempt to build a wheel
 automatically and insert it into the wheel cache.
@@ -798,6 +801,7 @@ Examples
       $ pip install git+https://git.repo/some_pkg.git#egg=SomePackage[PDF]
       $ pip install SomePackage[PDF]==3.0
       $ pip install -e .[PDF]==3.0  # editable project in current directory
+      $ pip install SomePackage[PDF,EPUB]  # multiple extras
 
 
 #. Install a particular source archive file.

news/2386.removal

@@ -1,5 +1,5 @@
 Removed support for uninstalling projects which have been installed using
 distutils. distutils installed projects do not include metadata indicating
 what files belong to that install and thus it is impossible to *actually*
-install them rather than just remove the metadata saying they've been installed
-while leaving all of the actual files behind.
+uninstall them rather than just remove the metadata saying they've been
+installed while leaving all of the actual files behind.

news/3015.bugfix

@@ -0,0 +1 @@
+Correctly reset the terminal if an exception occurs while a progress bar is being shown.

news/3236.bugfix

@@ -0,0 +1 @@
+"Support URL-encoded characters in URL credentials."

news/3876.bugfix

@@ -0,0 +1 @@
+Support installing from Git refs