The Chaos Toolkit reporting extension library.

The purpose of this library is to provide reporting support to the Chaos Toolkit experiment results.

The library takes the journal generated by the chaos run command and transforms into a human friendly report. The report can be a standalone PDF or HTML document.

Install this package as any other Python packages:

$ pip install -U chaostoolkit-reporting

Notice that this draws a few dependencies:

Some of them are LGPL v3 licensed.

If you are using Mac OS X then you will need to install some additional dependencies that the chaos report command relies upon.

You will also need to install the pandoc package on your system.

If you intend on creating PDF reports, the following additional packages will be needed:

$ sudo apt-get install texlive-latex-base \
    texlive-fonts-recommended \
    texlive-fonts-extra \
    texlive-latex-extra \
    pdflatex

Once installed, a new report subcommand will be made available to the chaos command, use it as follows:

$ chaos report --export-format=html5 chaos-report.json report.html

or, for a PDF document:

$ chaos report --export-format=pdf chaos-report.json report.pdf

Contributors to this project are welcome as this is an open-source effort that seeks discussions and continuous improvement.

From a code perspective, if you wish to contribute, you will need to run a Python 3.5+ environment. Then, fork this repository and submit a PR. The project cares for code readability and checks the code style to match best practices defined in PEP8. Please also make sure you provide tests whenever you submit a PR so we keep the code reliable.