Merge branch 'main' into patch-1

Author: webknjaz

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: pip cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key:
+            ${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('noxfile.py') }}
+          restore-keys: |
+            ${{ matrix.os }}-${{ matrix.python-version }}-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade nox virtualenv
+
+      - name: Nox build
+        run: |
+          python -m nox -s build

.travis.yml

@@ -1,4 +1,5 @@
 sphinx==3.2.0
 sphinx-autobuild==0.7.1
+sphinx-inline-tabs==2020.10.19b4
 git+https://github.com/python/python-docs-theme.git#egg=python-docs-theme
 git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme

requirements.txt

@@ -34,6 +34,7 @@
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
+    'sphinx_inline_tabs',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -375,6 +376,7 @@
     'python': ('https://docs.python.org/3', None),
     'python2': ('https://docs.python.org/2', None),
     'pip': ('https://pip.pypa.io/en/latest/', None),
+    'setuptools': ('https://setuptools.rtfd.io/en/latest/', None),
 }
 
 

source/conf.py

@@ -79,7 +79,7 @@ need:
 1. `Nox <https://nox.readthedocs.io/en/latest/>`_. You can install or upgrade
    nox using ``pip``::
 
-      pip install --user nox
+      python -m pip install --user nox
 
 2. Python 3.6. Our build scripts are designed to work with Python 3.6 only.
    See the `Hitchhiker's Guide to Python installation instructions`_ to install

source/contribute.rst

@@ -83,7 +83,7 @@ packages. [1]_
 
 Whereas ``install_requires`` metadata is automatically analyzed by pip during an
 install, requirements files are not, and only are used when a user specifically
-installs them using ``pip install -r``.
+installs them using ``python -m pip install -r``.
 
 ----
 

source/discussions/install-requires-vs-requirements.rst

@@ -27,13 +27,13 @@ Here's a breakdown of the important differences between pip and easy_install now
 |Installs from :term:`Wheels   |Yes                                   |No                             |
 |<Wheel>`                      |                                      |                               |
 +------------------------------+--------------------------------------+-------------------------------+
-|Uninstall Packages            |Yes (``pip uninstall``)               |No                             |
+|Uninstall Packages            |Yes (``python -m pip uninstall``)     |No                             |
 +------------------------------+--------------------------------------+-------------------------------+
 |Dependency Overrides          |Yes (:ref:`Requirements Files         |No                             |
 |                              |<pip:Requirements Files>`)            |                               |
 +------------------------------+--------------------------------------+-------------------------------+
-|List Installed Packages       |Yes (``pip list`` and ``pip           |No                             |
-|                              |freeze``)                             |                               |
+|List Installed Packages       |Yes (``python -m pip list`` and       |No                             |
+|                              |``python -m pip freeze``)             |                               |
 +------------------------------+--------------------------------------+-------------------------------+
 |:pep:`438`                    |Yes                                   |No                             |
 |Support                       |                                      |                               |

source/discussions/pip-vs-easy-install.rst

@@ -68,10 +68,10 @@ the `BigQuery quickstart guide
 Data schema
 -----------
 
-Linehaul writes an entry in a ``the-psf.pypi.file_downloads`` table for each
+Linehaul writes an entry in a ``bigquery-public-data.pypi.file_downloads`` table for each
 download. The table contains information about what file was downloaded and how
 it was downloaded. Some useful columns from the `table schema
-<https://console.cloud.google.com/bigquery?pli=1&p=the-psf&d=pypi&t=file_downloads&page=table>`__
+<https://console.cloud.google.com/bigquery?pli=1&p=bigquery-public-data&d=pypi&t=file_downloads&page=table>`__
 include:
 
 +------------------------+-----------------+-----------------------------+
@@ -108,7 +108,7 @@ The following query counts the total number of downloads for the project
 
     #standardSQL
     SELECT COUNT(*) AS num_downloads
-    FROM `the-psf.pypi.file_downloads`
+    FROM `bigquery-public-data.pypi.file_downloads`
     WHERE file.project = 'pytest'
       -- Only query the last 30 days of history
       AND DATE(timestamp)
@@ -118,7 +118,7 @@ The following query counts the total number of downloads for the project
 +---------------+
 | num_downloads |
 +===============+
-| 20531925      |
+| 26190085      |
 +---------------+
 
 To only count downloads from pip, filter on the ``details.installer.name``
@@ -128,7 +128,7 @@ column.
 
     #standardSQL
     SELECT COUNT(*) AS num_downloads
-    FROM `the-psf.pypi.file_downloads`
+    FROM `bigquery-public-data.pypi.file_downloads`
     WHERE file.project = 'pytest'
       AND details.installer.name = 'pip'
       -- Only query the last 30 days of history
@@ -139,7 +139,7 @@ column.
 +---------------+
 | num_downloads |
 +===============+
-| 19391645      |
+| 24334215      |
 +---------------+
 
 Package downloads over time
@@ -154,7 +154,7 @@ filtering by this column reduces corresponding costs.
     SELECT
       COUNT(*) AS num_downloads,
       DATE_TRUNC(DATE(timestamp), MONTH) AS `month`
-    FROM `the-psf.pypi.file_downloads`
+    FROM `bigquery-public-data.pypi.file_downloads`
     WHERE
       file.project = 'pytest'
       -- Only query the last 6 months of history
@@ -192,7 +192,7 @@ query processes over 500 GB of data.
     SELECT
       REGEXP_EXTRACT(details.python, r"[0-9]+\.[0-9]+") AS python_version,
       COUNT(*) AS num_downloads,
-    FROM `the-psf.pypi.file_downloads`
+    FROM `bigquery-public-data.pypi.file_downloads`
     WHERE
       -- Only query the last 6 months of history
       DATE(timestamp)
@@ -204,17 +204,17 @@ query processes over 500 GB of data.
 +--------+---------------+
 | python | num_downloads |
 +========+===============+
-| 3.7    | 12990683561   |
+| 3.7    | 18051328726   |
 +--------+---------------+
-| 3.6    | 9035598511    |
+| 3.6    | 9635067203    |
 +--------+---------------+
-| 2.7    | 8467785320    |
+| 3.8    | 7781904681    |
 +--------+---------------+
-| 3.8    | 4581627740    |
+| 2.7    | 6381252241    |
 +--------+---------------+
-| 3.5    | 2412533601    |
+| null   | 2026630299    |
 +--------+---------------+
-| null   | 1641456718    |
+| 3.5    | 1894153540    |
 +--------+---------------+
 
 Caveats
@@ -251,7 +251,7 @@ the official Python client library for BigQuery.
 
     query_job = client.query("""
     SELECT COUNT(*) AS num_downloads
-    FROM `the-psf.pypi.file_downloads`
+    FROM `bigquery-public-data.pypi.file_downloads`
     WHERE file.project = 'pytest'
       -- Only query the last 30 days of history
       AND DATE(timestamp)
@@ -274,7 +274,7 @@ Install `pypinfo`_ using pip.
 
 ::
 
-    pip install pypinfo
+    python -m pip install pypinfo
 
 Usage:
 
@@ -303,7 +303,7 @@ References
 .. [#] `PyPI Download Counts deprecation email <https://mail.python.org/pipermail/distutils-sig/2013-May/020855.html>`__
 .. [#] `PyPI BigQuery dataset announcement email <https://mail.python.org/pipermail/distutils-sig/2016-May/028986.html>`__
 
-.. _public PyPI download statistics dataset: https://console.cloud.google.com/bigquery?p=the-psf&d=pypi&page=dataset
+.. _public PyPI download statistics dataset: https://console.cloud.google.com/bigquery?p=bigquery-public-data&d=pypi&page=dataset
 .. _bandersnatch: /key_projects/#bandersnatch
 .. _Google BigQuery: https://cloud.google.com/bigquery
 .. _BigQuery web UI: https://console.cloud.google.com/bigquery

source/guides/analyzing-pypi-package-downloads.rst

@@ -12,11 +12,10 @@ The section does *not* aim to cover best practices for Python project
 development as a whole.  For example, it does not provide guidance or tool
 recommendations for version control, documentation, or testing.
 
-For more reference material, see `Building and Distributing Packages
-<https://setuptools.readthedocs.io/en/latest/setuptools.html>`_ in the
-:ref:`setuptools` docs, but note that some advisory content there may be
-outdated. In the event of conflicts, prefer the advice in the Python
-Packaging User Guide.
+For more reference material, see :std:doc:`Building and Distributing
+Packages <userguide/index>` in the :ref:`setuptools` docs, but note
+that some advisory content there may be outdated. In the event of
+conflicts, prefer the advice in the Python Packaging User Guide.
 
 .. contents:: Contents
    :local:
@@ -32,7 +31,7 @@ Requirements for packaging and distributing
 
    ::
 
-    pip install twine
+    python -m pip install twine
 
    You'll need this to upload your project :term:`distributions <Distribution
    Package>` to :term:`PyPI <Python Package Index (PyPI)>` (see :ref:`below
@@ -445,9 +444,9 @@ The value must be a mapping from package name to a list of relative path names
 that should be copied into the package. The paths are interpreted as relative to
 the directory containing the package.
 
-For more information, see `Including Data Files
-<https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files>`_
-from the `setuptools docs <https://setuptools.readthedocs.io>`_.
+For more information, see :std:doc:`Including Data Files
+<setuptools:userguide/datafiles>` from the
+:std:doc:`setuptools docs <setuptools:index>`.
 
 
 .. _`Data Files`:
@@ -652,7 +651,7 @@ maintained by a redistributor.
 A local version identifier takes the form ``<public version identifier>+<local version label>``.
 For example::
 
-   1.2.0.dev1+hg.5.b11e5e6f0b0b  # 5th VCS commmit since 1.2.0.dev1 release
+   1.2.0.dev1+hg.5.b11e5e6f0b0b  # 5th VCS commit since 1.2.0.dev1 release
    1.2.1+fedora.4                # Package with downstream Fedora patches applied
 
 
@@ -670,7 +669,7 @@ Change directory to the root of the project directory and run ``pip install -e .
 
 ::
 
- pip install -e .
+ python -m pip install -e .
 
 
 The pip command-line flag ``-e`` is short for ``--editable``, and ``.`` refers
@@ -702,7 +701,7 @@ see the :ref:`VCS Support <pip:VCS Support>` section of the pip docs.
 
 Lastly, if you don't want to install any dependencies at all, you can run::
 
-   pip install -e . --no-deps
+   python -m pip install -e . --no-deps
 
 
 For more information, see the `Development Mode
@@ -762,7 +761,7 @@ Before you can build wheels for your project, you'll need to install the
 
 .. code-block:: text
 
-  pip install wheel
+  python -m pip install wheel
 
 
 .. _`Universal Wheels`:

source/guides/distributing-packages-using-setuptools.rst

@@ -32,7 +32,7 @@ Ensure that before you generate source distributions or binary distributions, yo
 
 Steps::
 
-   pip install --upgrade setuptools twine
+   python -m pip install --upgrade setuptools twine
 
 `setuptools` version should be above 24.0.0.