Simple report using the SDK

.gitignore

@@ -9,6 +9,8 @@ mazerunner_sdk.egg-info/
 dist
 .coverage
 .cache
-sdk-venv
+.sdk
 htmlcov
 test_deployments
+venv
+.pytest_cache

PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 1.2.3
+Name: mazerunner_sdk_python
+Version: 1.2.3
+Summary: MazeRunner python SDK
+Home-page: https://github.com/Cymmetria/mazerunner_sdk_python
+Author: Cymmetria
+License: BSD-3
+Download-URL: https://github.com/Cymmetria/mazerunner_sdk_python/archive/1.2.3.tar.gz
+Description: This library implements a convenient client for MazeRunner™ API for Python.
+        Using this library, you will be able to easily configure and manipulate the key features
+        of MazeRunner, such as the creation of a deception campaign, turning decoys on or off, deployment on
+        remote endpoints, and inspecting alerts with their attached evidence.
+
+        See the documentation at https://community.cymmetria.com/api
+
+        Fork us at https://github.com/Cymmetria/mazerunner_sdk_python
+
+Keywords: mazerunner, sdk, python, deception
+Requires: argparse
+Requires: mohawk
+Requires: requests
+Requires: requests-hawk
+Requires: six
+Requires: wsgiref
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Topic :: Software Development :: Libraries

README.md

@@ -33,8 +33,8 @@ Structure of the json_credentials file:
 
 ###Generate documentation files:
 ~~~~
-export PYTHONPATH=`pwd`
-make html
+make dev-env
+make docs
 ~~~~
 
 ###See documentation at [https://community.cymmetria.com/api](https://community.cymmetria.com/api)

conftest.py

@@ -1,4 +1,5 @@
 def pytest_addoption(parser):
+    parser.addoption("--initial_clean", action="store_true", default=False)
     parser.addoption("--json_credentials", action="store", default=None,
                      help="Json file with the relevant credentials")
     parser.addoption("--runslow", action="store_true", default=False, help="Run slow tests")

makefile

@@ -0,0 +1,16 @@
+SHELL := /bin/bash
+
+.PHONY: dev-env
+dev-env:
+	sudo apt-get install -y texlive-latex-extra texlive-fonts-recommended python-sphinx; \
+	virtualenv .sdk; \
+	source .sdk/bin/activate; \
+	pip install -r requirements.txt; \
+	pip install -r testing_requirements.txt;
+
+.PHONY: docs
+docs: export PYTHONPATH = $(shell pwd):$(shell pwd)/mazerunner:$(shell pwd)/mazerunner/samples
+docs:
+	source .sdk/bin/activate; \
+	make -f sphinx_makefile html latexpdf
+	cp build/latex/MazeRunnerSDK.pdf build/html/sdk.pdf