Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Report on the tools used in your software pipeline.

Project description

toolaudit
=========

`|Build Status| <https://travis-ci.org/jstutters/toolaudit>`_

Report on the tools used in your software pipeline.

Purpose
-------

``toolaudit`` provides a way of monitoring a collection of software
programs for version changes and is also able test functionality. It
written to assist with the auditing of software pipelines in
neuroscience research.

Usage
-----

``toolaudit`` uses `YAML <http://yaml.org/>`_ to describe software
collections. A simple example of one of these descriptions is:

::

---
tools:
- name: cat
path: /bin/cat
reader:
name: command_line
option: --version
regex: "^cat\\s\\(GNU\\scoreutils\\)\\s([0-9\\.]*)$"
test:
name: stdout
command: "{exe} {file1} {file2}"
inputs:
file1: foo.txt
file2: bar.txt

A simple invocation of toolaudit is: ``bash $ toolaudit example.yaml``

For the above example this would return:

::

---
tools:
- checksum: 9c3bb3efa8095f36aafd9bf3a698efe439505021
name: cat
output_checksum: 533fbb1dc1a426ecf19af2f8e4f01c59491e6f8f
path: /bin/cat
reader: {name: command_line, option: --version, regex: '^cat\s\(GNU\scoreutils\)\s([0-9\.]*)$'}
tester:
command: '{exe} {file1} {file2}'
inputs: {file1: foo.txt, file2: bar.txt}
name: stdout
version: '8.4'

The checksum is a SHA1 hash of the file identified at *path*. The output
checksum is a SHA1 hash of the what was printed to stdout.

Documentation
-------------

Full documentation is at:
`toolaudit.readthedocs.org <https://toolaudit.readthedocs.org/>`_.

Release History
---------------

0.0.5
~~~~~

- Allow user to choose to ignore non-zero return code when using the
fileout test

0.0.4
~~~~~

- Fixed crash when the line\_in\_file version reader was used with no
arguments

0.0.3
~~~~~

- Added support for Python 3
- Added the --onlytest option to run a specific test

0.0.2
~~~~~

- Initial public release

License
-------

``toolaudit`` is licensed under `The MIT
License <http://opensource.org/licenses/MIT>`_.

.. |Build
Status| image:: https://travis-ci.org/jstutters/toolaudit.svg?branch=master

Project details


Release history Release notifications

This version
History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
toolaudit-0.0.5.tar.gz (10.3 kB) Copy SHA256 hash SHA256 Source None May 15, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page