Chaos engineering toolkit reporting library
Project description
# chaostoolkit-reporting
[![Build Status](https://travis-ci.org/chaostoolkit/chaostoolkit-reporting.svg?branch=master)](https://travis-ci.org/chaostoolkit/chaostoolkit-reporting)
The Chaos Toolkit reporting extension library.
## Purpose
The purpose of this library is to provide reporting support to the
[Chaos Toolkit][chaostoolkit] experiment results.
[chaostoolkit]: http://chaostoolkit.org
## Features
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
Install this package as any other Python packages:
```
$ pip install -U chaostoolkit-reporting
```
Notice that this draws a few [dependencies][deps]:
[deps]: https://github.com/chaostoolkit/chaostoolkit-reporting/blob/master/requirements.txt
Some of them are LGPL v3 licensed.
If you are using Mac OS X then you will need to [install some additional dependencies](osx-install.md) that the `chaos report` command relies upon.
You will also need to install the [pandoc][] package on your system.
[pandoc]: https://pandoc.org/
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
```
## Usage
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
```
## Contribute
Contributors to this project are welcome as this is an open-source effort that
seeks [discussions][join] and continuous improvement.
[join]: https://join.chaostoolkit.org/
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][pep8]. Please also make sure you provide tests
whenever you submit a PR so we keep the code reliable.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
[![Build Status](https://travis-ci.org/chaostoolkit/chaostoolkit-reporting.svg?branch=master)](https://travis-ci.org/chaostoolkit/chaostoolkit-reporting)
The Chaos Toolkit reporting extension library.
## Purpose
The purpose of this library is to provide reporting support to the
[Chaos Toolkit][chaostoolkit] experiment results.
[chaostoolkit]: http://chaostoolkit.org
## Features
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
Install this package as any other Python packages:
```
$ pip install -U chaostoolkit-reporting
```
Notice that this draws a few [dependencies][deps]:
[deps]: https://github.com/chaostoolkit/chaostoolkit-reporting/blob/master/requirements.txt
Some of them are LGPL v3 licensed.
If you are using Mac OS X then you will need to [install some additional dependencies](osx-install.md) that the `chaos report` command relies upon.
You will also need to install the [pandoc][] package on your system.
[pandoc]: https://pandoc.org/
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
```
## Usage
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
```
## Contribute
Contributors to this project are welcome as this is an open-source effort that
seeks [discussions][join] and continuous improvement.
[join]: https://join.chaostoolkit.org/
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][pep8]. Please also make sure you provide tests
whenever you submit a PR so we keep the code reliable.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for chaostoolkit-reporting-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cc7b117a63aba7c48c21b8ccd0ba41bee521c27a1f930ed4bba9d70384e7871 |
|
MD5 | 35e0a8cffbcf8941a8beafbc8e7888ba |
|
BLAKE2b-256 | e27efd18b5398ac95323dc63b447cf611924e9ef3fe681bf43dd1f0037bd3c5f |
Close
Hashes for chaostoolkit_reporting-0.8.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1048150d42bad768f835a8825c421562d40d9930fb7cb1634a9614b28ae5cbf3 |
|
MD5 | 18be0f796ac46cd0b1faa0dbb548fc13 |
|
BLAKE2b-256 | 954004fe4bf4bc3dd7c5f6ac9a01016ae9110b0970599eb7488da1873b06a126 |