Skip to main content

cli tool to verify and update requirements files

Project description

Build Status Latest Version Python Support

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 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 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_to_expand.txt in expand

Continuous Integration

Use it in your CI of choice!!!

travis

services:
  - docker

before_script:
  - pip install cireqs

script:
  - cireqs verify

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  Expand given requirements file by extending...
  verify  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 (2017-11-01)

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

  • message when commands are successful

1.0.3 (2018-03-26)

  • Handle pip giving an upgrade warning

1.0.4 (2018-07-24)

  • Upgrade pip before installing requirements to avoid upgrade error.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cireqs-1.0.4.tar.gz (6.7 kB view details)

Uploaded Source

File details

Details for the file cireqs-1.0.4.tar.gz.

File metadata

  • Download URL: cireqs-1.0.4.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cireqs-1.0.4.tar.gz
Algorithm Hash digest
SHA256 cae7395543b0436a0be4dc8c1351a31080b04aebffde8de5313f1554baf2e2a9
MD5 5568d03a8e5550969ad8711dd595e61a
BLAKE2b-256 85684faec799d702d561d68caa00c20d693b7f0876535ba7a0c17beffb509103

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page