cireqs 1.0.0

cli tool to verify and update requirements files

cireqs

Tool to expand and pin requirements files and verify that they are complete.

Installation

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.

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.

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

Continuous Integration

Use it in your CI of choice!!!

travis

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...

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

0.2.2 (2017-08-14)

• default timeout value for docker operations increased to 120 seconds (from 10)

1.0.0 (2018-11-01)

• introduce verify and expand and deprecate verify_requirements and expand_requirements by showing warnings

• message when commands are successfull