Metadata-Version: 1.2
Name: pip-tools
Version: 3.0.0
Summary: pip-tools keeps your pinned dependencies fresh.
Home-page: https://github.com/jazzband/pip-tools/
Author: Vincent Driessen
Author-email: me@nvie.com
License: BSD
Description: |buildstatus-travis| |buildstatus-appveyor| |jazzband| |pypi|
        
        ==================================
        pip-tools = pip-compile + pip-sync
        ==================================
        
        A set of command line tools to help you keep your ``pip``-based packages fresh,
        even when you've pinned them.  `You do pin them, right?`_
        
        .. image:: https://github.com/jazzband/pip-tools/raw/master/img/pip-tools-overview.png
           :alt: pip-tools overview for phase II
        
        .. |buildstatus-travis| image:: https://img.shields.io/travis/jazzband/pip-tools/master.svg
           :alt: Travis-CI build status
           :target: https://travis-ci.org/jazzband/pip-tools
        .. |buildstatus-appveyor| image:: https://img.shields.io/appveyor/ci/jazzband/pip-tools/master.svg
           :alt: Appveyor build status
           :target: https://ci.appveyor.com/project/jazzband/pip-tools
        .. |jazzband| image:: https://jazzband.co/static/img/badge.svg
           :alt: Jazzband
           :target: https://jazzband.co/
        .. |pypi| image:: https://img.shields.io/pypi/v/pip-tools.svg
           :alt: PyPI
           :target: https://pypi.org/project/pip-tools/
        .. _You do pin them, right?: http://nvie.com/posts/pin-your-packages/
        
        
        Installation
        ============
        
        As part of a Python project's environment tooling (similar to ``pip``), it's
        recommended to install ``pip-tools`` in each project's `virtual environment`_:
        
        .. code-block:: bash
        
            $ source /path/to/venv/bin/activate
            (venv)$ pip install pip-tools
        
        **Note**: all of the remaining example commands assume you've activated your
        project's virtual environment.
        
        .. _virtual environment: https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments
        
        Example usage for ``pip-compile``
        =================================
        
        Requirements from ``setup.py``
        ------------------------------
        
        Suppose you have a Flask project, and want to pin it for production.
        If you have a ``setup.py`` with ``install_requires=['Flask']``, then run
        ``pip-compile`` without any arguments:
        
        .. code-block:: bash
        
            $ pip-compile
            #
            # This file is autogenerated by pip-compile
            # To update, run:
            #
            #    pip-compile --output-file requirements.txt setup.py
            #
            click==6.7                # via flask
            flask==0.12.2
            itsdangerous==0.24        # via flask
            jinja2==2.9.6             # via flask
            markupsafe==1.0           # via jinja2
            werkzeug==0.12.2          # via flask
        
        ``pip-compile`` will produce your ``requirements.txt``, with all the Flask
        dependencies (and all underlying dependencies) pinned.  You should put
        ``requirements.txt`` under version control.
        
        Without ``setup.py``
        --------------------
        
        If you don't use ``setup.py`` (`it's easy to write one`_), you can create a
        ``requirements.in`` file to declare the Flask dependency:
        
        .. code-block:: ini
        
            # requirements.in
            Flask
        
        Now, run ``pip-compile requirements.in``:
        
        .. code-block:: bash
        
            $ pip-compile requirements.in
            #
            # This file is autogenerated by pip-compile
            # To update, run:
            #
            #    pip-compile --output-file requirements.txt requirements.in
            #
            click==6.7                # via flask
            flask==0.12.2
            itsdangerous==0.24        # via flask
            jinja2==2.9.6             # via flask
            markupsafe==1.0           # via jinja2
            werkzeug==0.12.2          # via flask
        
        And it will produce your ``requirements.txt``, with all the Flask dependencies
        (and all underlying dependencies) pinned.  You should put both
        ``requirements.in`` and ``requirements.txt`` under version control.
        
        .. _it's easy to write one: https://packaging.python.org/distributing/#configuring-your-project
        
        Using hashes
        ------------
        
        If you would like to use *Hash-Checking Mode* available in ``pip`` since
        version 8.0, ``pip-compile`` offers ``--generate-hashes`` flag:
        
        .. code-block:: bash
        
            $ pip-compile --generate-hashes requirements.in
            #
            # This file is autogenerated by pip-compile
            # To update, run:
            #
            #    pip-compile --generate-hashes --output-file requirements.txt requirements.in
            #
            click==6.7 \
                --hash=sha256:29f99fc6125fbc931b758dc053b3114e55c77a6e4c6c3a2674a2dc986016381d \
                --hash=sha256:f15516df478d5a56180fbf80e68f206010e6d160fc39fa508b65e035fd75130b \
                # via flask
            flask==0.12.2 \
                --hash=sha256:0749df235e3ff61ac108f69ac178c9770caeaccad2509cb762ce1f65570a8856 \
                --hash=sha256:49f44461237b69ecd901cc7ce66feea0319b9158743dd27a2899962ab214dac1
            itsdangerous==0.24 \
                --hash=sha256:cbb3fcf8d3e33df861709ecaf89d9e6629cff0a217bc2848f1b41cd30d360519 \
                # via flask
            jinja2==2.9.6 \
                --hash=sha256:2231bace0dfd8d2bf1e5d7e41239c06c9e0ded46e70cc1094a0aa64b0afeb054 \
                --hash=sha256:ddaa01a212cd6d641401cb01b605f4a4d9f37bfc93043d7f760ec70fb99ff9ff \
                # via flask
            markupsafe==1.0 \
                --hash=sha256:a6be69091dac236ea9c6bc7d012beab42010fa914c459791d627dad4910eb665 \
                # via jinja2
            werkzeug==0.12.2 \
                --hash=sha256:903a7b87b74635244548b30d30db4c8947fe64c5198f58899ddcd3a13c23bb26 \
                --hash=sha256:e8549c143af3ce6559699a01e26fa4174f4c591dbee0a499f3cd4c3781cdec3d \
                # via flask
        
        Updating requirements
        ---------------------
        
        To update all packages, periodically re-run ``pip-compile --upgrade``.
        
        To update a specific package to the latest or a specific version use the
        ``--upgrade-package`` or ``-P`` flag:
        
        .. code-block:: bash
        
            $ pip-compile --upgrade-package flask  # only update the flask package
            $ pip-compile --upgrade-package flask --upgrade-package requests  # update both the flask and requests packages
            $ pip-compile -P flask -P requests  # same as above, but shorter
        
        If you use multiple Python versions, you can run ``pip-compile`` as
        ``py -X.Y -m piptools compile ...`` on Windows and
        ``pythonX.Y -m piptools compile ...`` on other systems.
        
        Configuration
        -------------
        
        You might be wrapping the ``pip-compile`` command in another script. To avoid
        confusing consumers of your custom script you can override the update command
        generated at the top of requirements files by setting the
        ``CUSTOM_COMPILE_COMMAND`` environment variable.
        
        .. code-block:: bash
        
            $ CUSTOM_COMPILE_COMMAND="./pipcompilewrapper" pip-compile requirements.in
            #
            # This file is autogenerated by pip-compile
            # To update, run:
            #
            #    ./pipcompilewrapper
            #
            flask==0.10.1
            itsdangerous==0.24        # via flask
            jinja2==2.7.3             # via flask
            markupsafe==0.23          # via jinja2
            werkzeug==0.10.4          # via flask
        
        Example usage for ``pip-sync``
        ==============================
        
        Now that you have a ``requirements.txt``, you can use ``pip-sync`` to update
        your virtual environment to reflect exactly what's in there. This will
        install/upgrade/uninstall everything necessary to match the
        ``requirements.txt`` contents.
        
        **Be careful**: ``pip-sync`` is meant to be used only with a
        ``requirements.txt`` generated by ``pip-compile``.
        
        .. code-block:: bash
        
            $ pip-sync
            Uninstalling flake8-2.4.1:
              Successfully uninstalled flake8-2.4.1
            Collecting click==4.1
              Downloading click-4.1-py2.py3-none-any.whl (62kB)
                100% |████████████████████████████████| 65kB 1.8MB/s
              Found existing installation: click 4.0
                Uninstalling click-4.0:
                  Successfully uninstalled click-4.0
            Successfully installed click-4.1
        
        To sync multiple ``*.txt`` dependency lists, just pass them in via command
        line arguments, e.g.
        
        .. code-block:: bash
        
            $ pip-sync dev-requirements.txt requirements.txt
        
        Passing in empty arguments would cause it to default to ``requirements.txt``.
        
        If you use multiple Python versions, you can run ``pip-sync`` as
        ``py -X.Y -m piptools sync ...`` on Windows and
        ``pythonX.Y -m piptools sync ...`` on other systems.
        
        **Note**: ``pip-sync`` will not upgrade or uninstall packaging tools like
        ``setuptools``, ``pip``, or ``pip-tools`` itself. Use ``pip install --upgrade``
        to upgrade those packages.
        
        Other useful tools
        ==================
        
        - `pipdeptree`_ to print the dependency tree of the installed packages.
        
        .. _pipdeptree: https://github.com/naiquevin/pipdeptree
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
