Skip to content

Commit

Permalink
Bug 1490253 - Update documentation on vendoring Python packages based…
Browse files Browse the repository at this point in the history
… on switch to pip-tools; r=ahal

Differential Revision: https://phabricator.services.mozilla.com/D8205
  • Loading branch information
davehunt committed Oct 15, 2018
1 parent fa9b46f commit 804d85b
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions python/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,13 @@ full list of dependencies. The requirements file is then used with ``pip`` to
download and extract the source distributions of all packages into the
``third_party/python`` directory.

If you're familiar with ``Pipfile`` you can also directly modify this in the in
the top source directory and then run ``mach vendor python`` for your changes
to take effect. This allows advanced options such as specifying alternative
package indexes (see below), and
`PEP 508 specifiers <https://www.python.org/dev/peps/pep-0508/>`_.

Note that the `specification <https://github.com/pypa/pipfile>`_ for
``Pipfile`` and ``Pipfile.lock`` is still in active development. More
information can be found in the
`Pipenv documentation <https://docs.pipenv.org/>`_, which is the reference
implementation we're using.
Alternatively, you can also modify the direct dependencies in
``third_party/python/requirements.in`` and then run ``mach vendor python`` for your
changes to take effect.

What if the package isn't on PyPI?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If the package is available on another Python package index, then you can add
these details to ``Pipfile`` by
`specifying package indexes <https://docs.pipenv.org/advanced/#specifying-package-indexes>`_.
If the package isn't available on any Python package index, then you can
manually copy the source distribution into the ``third_party/python`` directory.

Expand Down

0 comments on commit 804d85b

Please sign in to comment.