混沌工程工具包报告库
chaostoolkit-reporting的Python项目详细描述
朝圣报
混沌工具包报告扩展库。
目的
此库的目的是为 Chaos Toolkit实验结果。
功能
库接受由chaos run命令生成的日志
变成一份人性化的报告。报告可以是独立的
PDF或HTML文档。
安装
将此软件包安装为任何其他python软件包：
$ pip install -U chaostoolkit-reporting
注意，这画了几个dependencies：
其中一些是lgpl v3授权的。
如果您使用的是mac os x，那么需要chaos report命令所依赖的install some additional dependencies。
您还需要在系统上安装pandoc包。
如果您打算创建pdf报告，以下附加包将 需要：
$ sudo apt-get install texlive-latex-base \
texlive-fonts-recommended \
texlive-fonts-extra \
texlive-latex-extra \
pdflatex
下载Docker图片
由于此插件的依赖关系可能很难正确处理，因此我们还 提供Docker图像。请注意，此图像相当大，1.4gb到 拉
$ docker pull chaostoolkit/reporting
用法
一旦安装，新的report子命令将提供给
chaos命令，使用如下：
$ chaos report --export-format=html5 chaos-report.json report.html
或者，对于pdf文档：
$ chaos report --export-format=pdf chaos-report.json report.pdf
您还可以同时从多个日记账生成单个报表：
$ chaos report --export-format=pdf journal-1.json journal-2 journal-3 report.pdf
或者更简洁地说：
$ chaos report --export-format=pdf journal-*.json report.pdf
使用Docker容器
要使用Docker图像生成PDF报告，请执行以下操作：
$ ls . journal.json$ docker run \ --user `id -u`\ -v `pwd`:/tmp/result \ -it \ chaostoolkit/reporting $ ls . journal.json report.pdf chaostoolkit.log
如您所见，应该从journal.json运行该命令。
可以找到在实验运行期间生成的文件。这将创建
report.pdf在这个目录中
文件将由命令id -u返回的用户id拥有，它应该
做你的用户。我们指定用户的原因是，默认情况下，容器
以根用户身份运行，图像不会猜测哪个用户将运行
集装箱如果没有id命令，则可以设置该值
改为按如下方式手动：--user 1000:1000假设您的用户和
组id是1000。
映像的默认命令相当于在没有 容器：
$ chaos report --export-format=pdf journal.json report.pdf
如果要重写该命令，请将chaos report参数作为
如下：
$ docker run \ --user `id -u`\ -v `pwd`:/tmp/result \ -it \ chaostoolkit/reporting -- report --export-format=html5 journal.json report.html $ ls . journal.json report.html chaostoolkit.log
贡献
这个项目的贡献者是受欢迎的，因为这是一个开源的工作 寻求discussions和持续改进
从代码的角度来看，如果您希望贡献，您将需要运行 Python3.5+环境。然后，分叉这个存储库并提交一个PR project关注代码的可读性，并检查代码样式以使其与 在PEP8中定义的实践。请确保您提供了测试 每当你提交一个公关，所以我们保持代码的可靠性。
欢迎加入QQ群-->： 979659372
