revert remove docs

Author: Dan Hertz

Makefile

@@ -0,0 +1,30 @@
+.PHONY: help clean dev docs serve-docs package test
+
+help:
+	@echo "This project assumes that an active Python virtualenv is present."
+	@echo "The following make targets are available:"
+	@echo "	dev 	install all deps for dev env"
+	@echo "	docs	create pydocs for all relveant modules"
+	@echo "	serve-docs	serve generated documentation locally"
+	@echo "	test	run all tests with coverage"
+
+clean:
+	rm -rf dist/*
+
+dev:
+	pip install -r dev-requirements.txt
+	pip install -e .
+
+docs:
+	$(MAKE) -C docsrc html
+	@cp -a docsrc/_build/html/. docs
+
+serve-docs:
+	python3 -m http.server --directory docs
+
+package:
+	python -m build --sdist --wheel --outdir dist/
+
+test:
+	coverage run -m unittest discover
+	coverage html

docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 896b03f6111f682ae6016d8ce3222ee9
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/.nojekyll

@@ -0,0 +1,15 @@
+API
+===
+
+Nightfall Object
+----------------
+
+.. automodule:: nightfall.api
+    :members:
+    :private-members:
+
+Exceptions
+----------
+
+.. automodule:: nightfall.exceptions
+    :members:

docs/_sources/api.rst.txt

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG

docs/_sources/changelog.rst.txt

@@ -0,0 +1,11 @@
+.. Nightfall documentation master file, created by
+   sphinx-quickstart on Thu Jun 10 23:19:08 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Nightfall's documentation!
+=====================================
+
+The Nightfall library is a python SDK for the `Nightfall API <https://nightfall.ai/>`_. 
+
+.. include:: contents.rst.inc

docs/_sources/index.rst.txt

@@ -0,0 +1,57 @@
+Quickstart
+==========
+
+Installation
+------------
+
+.. note::
+    Nightfall requires Python 3.6 or higher. 
+
+You can install the latest version of Nightfall with:
+
+::
+
+    pip install nightfall
+
+Basic Usage
+-----------
+
+Make a new `API Token <https://app.nightfall.ai/api/>`_ and `Detection Set <https://app.nightfall.ai/detection-engine/detection-rules>`_ in the Nightfall UI and export these as environment variables.
+
+Import Nightfall and start using methods:
+
+::
+
+    from nightfall import Nightfall
+
+    nightfall = Nightfall(
+        os.getenv('NIGHTFALL_TOKEN'),
+        os.getenv('NIGHTFALL_CONDITION_SET')
+        )
+
+    response = nightfall.scan({'id': 'test string'})
+
+    print(response)    
+
+Enable Debug Logging
+--------------------
+
+Log API request and response data to the console:
+
+::
+
+    import logging
+
+    nightfall = Nightfall(token, condition_set)
+    logging.basicConfig()
+    nightfall.logger.setLevel(logging.DEBUG)
+
+Log API request and response data to a file:
+
+::
+
+    import logging
+
+    nightfall = Nightfall(token, condition_set)
+    logging.basicConfig(filename="./nightfall_log.txt)
+    nightfall.logger.setLevel(logging.DEBUG)