Iterate on Pipfile documentation

pull/649/head
Erik Sundell 2019-06-24 08:19:01 +02:00
rodzic 61a00f7929
commit 6ec9a15037
1 zmienionych plików z 9 dodań i 10 usunięć

Wyświetl plik

@ -59,17 +59,16 @@ though ``repo2docker`` support is best with Python 3.7, 3.6, 3.5 and 2.7.
``Pipfile`` and/or ``Pipfile.lock`` - Install a Python environment ``Pipfile`` and/or ``Pipfile.lock`` - Install a Python environment
================================================================== ==================================================================
``Pipfile`` and/or ``Pipfile.lock`` specifies a list of Python packages that `pipenv <https://github.com/pypa/pipenv/>`_ allows you to manage a virtual
should be installed in your environment. ``pipenv install --dev`` will be run to environment Python dependencies. When using ``pipenv``, you end up with
install the dependencies where the existence of a ``Pipfile.lock`` will make the ``Pipfile`` and ``Pipfile.lock`` files. The lock file contains explicit details
``Pipfile`` be ignored. about the packages that has been installed that met the criteria within the
``Pipfile``.
.. note:: If both ``Pipfile`` and ``Pipfile.lock`` are found by repo2docker, the former
will be ignored in favor of the lock file. Also note that these files
`pipenv <https://github.com/pypa/pipenv/>`_ and `virtualenv distinguish packages and development packages and that repo2docker will install
<https://github.com/pypa/virtualenv/>`_ and associated ``requirements.txt`` both kinds.
files are both managed by the Python Packaging Authority PyPA, where pipenv
and ``Pipfile`` and ``Pipfile.lock`` seem to be the modern solution.
.. _requirements.txt: .. _requirements.txt: