Skip to main content

System dependency version checker.

Project description

…chews through your system dependencies, spitting out incompatible
versions.

Unix: Unix Build Status Windows: Windows Build StatusMetrics: Coverage Status Scrutinizer Code QualityUsage: PyPI Version PyPI Downloads

Overview

When onboarding new team members, ensuring their computer has everything needed to work on the project can be painful. Verchew is a command-line program and embeddable Python script to check the versions of your project’s system dependencies. Its only external dependency is any Python interpreter, which should already be installed on macOS and most Linux-based operating systems.

Setup

Requirements

  • Python 2.7+ or Python 3.3+

Installation

Install verchew with pip:

$ pip install verchew

or directly from the source code:

$ git clone https://github.com/jacebrowning/verchew.git
$ cd verchew
$ python setup.py install

or embedded the script in your project using this guide.

Usage

Create a configuration file (.verchew.ini) containing your project’s system dependencies:

[Working Program]

cli = working-program
version = 1.2.

[Newer Working Program]

cli = working-program
version =  4.
message = Version 4 is required to get the special features

[Broken Program]

cli = broken-program
version = 1.2.3

[Optional Missing Program]

cli = missing-program
version = 1.2.3
optional = true

[Missing Program]

cli = missing-program
version = 1.2.3

Run verchew to see if you have the expected versions installed:

$ verchew

Checking for Working Program...

$ working-program --version
1.2.3
✔ MATCHED: 1.2.

Checking for Newer Working Program...

$ working-program --version
1.2.3
✘ EXPECTED: 4.

Checking for Broken Program...

$ broken-program --version
An error occurred.
✘ EXPECTED: 1.2.3

Checking for Optional Missing Program...

$ missing-program --version
sh: command not found: missing-program
⚠ EXPECTED: 1.2.3

Checking for Missing Program...

$ missing-program --version
sh: command not found: missing-program
✘ EXPECTED: 1.2.3

Results: ✔ ✘ ✘ ⚠ ✘

Revision History

1.2 (2017/09/13)

  • Added optional = true settings to downgrade errors to warnings.
  • Added message setting to display optional message for missing programs.

1.1 (2017/05/17)

  • Added --init command to generate a sample configuration file.

1.0 (2017/01/09)

  • Initial stable release.

0.5 (2016/11/02)

  • Added --exit-code option to return non-zero exit codes on failure.

0.4 (2016/10/20)

  • Added support for custom version arguments.
  • Fixed handling of internal versions matches.

0.3 (2016/10/18)

  • Added support for detecting missing and broken programs.

0.2.1 (2016/10/18)

  • Now stripping whitespace after calling --version on a program.

0.2 (2016/10/17)

  • Added --version command.

0.1 (2016/10/17)

  • Initial release.

Download files

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

Files for verchew, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size verchew-1.2-py2-none-any.whl (12.6 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size verchew-1.2.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page