Metadata-Version: 1.1
Name: cireqs
Version: 0.1.6
Summary: cli tool to verify and update requirements files
Home-page: https://github.com/trustpilot/python-cireqs
Author: jgv
Author-email: jgv@trustpilot.com
License: UNKNOWN
Description: |Build Status| |Latest Version| |Python Support|
        
        cireqs
        ======
        
        Tool to expand and pin requirements files and verify that they are
        complete.
        
        install
        -------
        
        Install from pypi.
        
        ``pip install cireqs``
        
        Cireqs needs a working install of docker locally.
        
        usage
        -----
        
        Use cireqs to expand and pin down your dependencies.
        
        You can then check in the resulting requirements file and stop worrying
        about floating versions.
        
        .. code:: bash
        
            cireqs --dirpath /tmp expand_requirements input_requirements_filename output_requirements_filename
        
        Use cireqs to verify that a requirements file is pinned down and
        includes all requirements of requirements.
        
        .. code:: bash
        
            cireqs verify_requirements input_requirements
        
        defaults
        ^^^^^^^^
        
        Cireqs uses overridable defaults:
        
        -  **dirpath:** set to current working directory (``PWD``)
        -  **pythonversion:** set to ``3.5.2``
        -  **output\_requirements\_filename:** set to ``requirements.txt``
        -  **input\_requirements\_filename:** set to:
        -  
        
           -  ``requirements.txt`` in *verify\_requirements*
        
        -  
        
           -  ``requirements_to_expand.txt`` in *expand\_requirements*
        
        continous integration
        ---------------------
        
        Use it in your **CI** of choice!!!
        
        **travis**
        
        .. code:: yaml
        
            services:
              - docker
        
            before_script:
              - pip install cireqs
        
            script:
              - cireqs verify_requirements
        
        cli
        ---
        
        Cireqs includes the ``cireqs`` command:
        
        ::
        
            Usage: cireqs [OPTIONS] COMMAND [ARGS]...
        
            Options:
              --pythonversion TEXT  python version to use for calculating dependencies
              --dirpath TEXT        path to directory containing requirement files,
                                    defaults to PWD
              -v, --verbosity LVL   Either CRITICAL, ERROR, WARNING, INFO or DEBUG
              --help                Show this message and exit.
        
            Commands:
              expand_requirements  Expand given requirements file by extending...
              verify_requirements  verifying that given requirements file is not...
        
        .. |Build Status| image:: https://travis-ci.org/trustpilot/python-cireqs.svg?branch=master
           :target: https://travis-ci.org/trustpilot/python-cireqs
        .. |Latest Version| image:: https://img.shields.io/pypi/v/cireqs.svg
           :target: https://pypi.python.org/pypi/cireqs
        .. |Python Support| image:: https://img.shields.io/pypi/pyversions/cireqs.svg
           :target: https://pypi.python.org/pypi/cireqs
        
        
        History
        =======
        
        0.0.1 (2017-08-09)
        ------------------
        
        * git init
        
        
        0.0.2 (2017-08-09)
        ------------------
        
        * missing manifest file
        
        0.0.3 (2017-08-10)
        ------------------
        
        * readme changes
        * cli splash changes
        * make cireqs functions pass python version to docker_execute
        * pass timeout param from cli to cireqs
        
        0.0.4 (2017-08-10)
        ------------------
        
        * tox testing for py27, py33, py34, py35, py36
        * more thorough diffing of requirements files
        * more tests
        * use prospector for linting
        
        0.1.3 (2017-08-11)
        ------------------
        
        * single source version in setup.py and cli
Keywords: cireqs requirements ci
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
