diff --git a/README.rst b/README.rst index 5de0e77..22c4994 100644 --- a/README.rst +++ b/README.rst @@ -3,18 +3,18 @@ Pipfile **Warning**: this project is under active development (and design). -A ``Pipfile`` (named ``requirements.pip``, and its sister ``requirements.piplock``), is a new (and much better!) +A ``Pipfile`` (named ``Pipfile``, and its sister ``Pipfile.freeze``), is a new (and much better!) replacement for the existing standard `pip `_'s ``requirements.txt`` file. Specifically, for a Python application, a ``Pipfile`` allows developers to specify *concrete* and sets of dependencies, their locations, and their loose version -constraints. A ``requirements.piplock`` can then be automatically generated during +constraints. A ``Pipfile.freeze`` can then be automatically generated during package installation to fully specify an exact set of known working versions, -and future installations may refer to the ``requirements.piplock`` to recreate the +and future installations may refer to the ``Pipfile.freeze`` to recreate the exact contents of the environment in a *deterministic* manner. A deployed web application, for instance, can be completely redeployed with the same exact -versions of all recursive dependencies, by referencing the ``requirements.piplock`` +versions of all recursive dependencies, by referencing the ``Pipfile.freeze`` file. ``pip`` will grow a new command line option, ``-p`` / ``--pipfile`` to install @@ -30,7 +30,7 @@ finalized. The Concept ----------- -A Pipfile (``requirements.pip``) will be superior to a ``requirements.txt`` file in a number of +A Pipfile (``Pipfile``) will be superior to a ``requirements.txt`` file in a number of ways: * Python-like syntax for declaring all types of Python dependencies. @@ -49,13 +49,13 @@ ways: first. * Fully specified (and *deterministic*) environments in the form of - ``requirements.piplock``. + ``Pipfile.freeze``. Example Pipfile +++++++++++++++ -Note—this is an evolving work in progress; filename is ``requirements.pip``:: +Note—this is an evolving work in progress; filename is ``Pipfile``:: source('https://pypi.org/', verify_ssl=True) @@ -85,8 +85,8 @@ Other / lower-level functions:: requires_platform('Windows') -Example requirements.piplock -++++++++++++++++++++++++++++ +Example Pipfile.freeze +++++++++++++++++++++++ Note—this file is always to be generated, not modified or constructed by a user:: @@ -146,21 +146,21 @@ Example Pip Integration (eventually) Install packages from ``Pipfile``:: $ pip install -p - ! Warning: requirements.piplock (48d35f) is out of date. Updating to (73d81f). + ! Warning: Pipfile.freeze (48d35f) is out of date. Updating to (73d81f). Installing packages from requirements.piplock... # Manually update lockfile. - $ pip freeze -p special_requirements.pip - special_requirements.piplock (73d81f) written to disk. + $ pip freeze -p special_pipfile + special_pipfile.freeze (73d81f) written to disk. Notes:: - # -p accepts a path argument, which defaults to 'requirements.pip'. - # requirements.piplock will be written automatically during `install -p` if it does not exist. + # -p accepts a path argument, which defaults to 'Pipfile'. + # Pipfile.freeze will be written automatically during `install -p` if it does not exist. Ideas:: -- Recursively look for `requirements.pip` in parent directories (limit 4?) when ``-p`` is bare. +- Recursively look for `Pipfile` in parent directories (limit 3/4?) when ``-p`` is bare. Useful Links