Merge pull request #7 from nightfallai/v1

v1 SDK

Author: Dhertz

.github/workflows/build-test-deploy.yml

@@ -19,12 +19,17 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r dev-requirements.txt
           pip install -e .
-      - name: Test with unittest
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
         env:
-          NIGHTFALL_CONDITION_SET: ${{ secrets.NIGHTFALL_CONDITION_SET }}
-          NIGHTFALL_TOKEN: ${{ secrets.NIGHTFALL_TOKEN }}
+          NIGHTFALL_API_KEY: ${{ secrets.NIGHTFALL_API_KEY }}
         run: |
-          python -m unittest discover
+          pytest -m "not filetest" --cov=nightfall --cov-report term-missing tests
       - name: Build a binary wheel and source tarball
         run: |
           python -m build --sdist --wheel --outdir dist/

.github/workflows/build-test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, "3.10"]
 
     steps:
       - uses: actions/checkout@v2
@@ -26,9 +26,8 @@ jobs:
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-      - name: Test with unittest
+      - name: Test with pytest
         env:
-          NIGHTFALL_CONDITION_SET: ${{ secrets.NIGHTFALL_CONDITION_SET }}
-          NIGHTFALL_TOKEN: ${{ secrets.NIGHTFALL_TOKEN }}
+          NIGHTFALL_API_KEY: ${{ secrets.NIGHTFALL_API_KEY }}
         run: |
-          python -m unittest discover
+          pytest -m "not filetest" --cov=nightfall --cov-report term-missing tests

Makefile

@@ -7,27 +7,29 @@ This is a python SDK for working with the Nightfall API.
 
 ## Installation 
 
-This module requires Python 3.6 or higher.
+This module requires Python 3.7 or higher.
 
 ```
 pip install nightfall
 ```
 
 ## Quickstart 
 
-Make a new [API Token](https://app.nightfall.ai/api/) and [Detection Rule Set](https://app.nightfall.ai/detection-engine/detection-rules) in Nightfall and store the values as environment variables.
+Make a new [API Token](https://app.nightfall.ai/api/) in Nightfall and store the value as an environment variable.
 
-```
-from nightfall import Nightfall
+```python
+import os
 
-nightfall = Nightfall(
-    os.getenv('NIGHTFALL_TOKEN'),
-    os.getenv('NIGHTFALL_CONDITION_SET')
-    )
+from nightfall import Confidence, DetectionRule, Detector, Nightfall
 
-response = nightfall.scan({'id': 'test string'})
+nightfall = Nightfall(os.getenv('NIGHTFALL_API_KEY'))
 
-print(response)
+findings, _ = nightfall.scan_text(
+        ["4916-6734-7572-5015 is my credit card number"],
+        [DetectionRule(
+            [Detector(min_confidence=Confidence.LIKELY,
+                     nightfall_detector="CREDIT_CARD_NUMBER")])])
+print(findings)
 ```
 
 For more information on the details of this library, please refer to 
@@ -50,25 +52,20 @@ environment with the following commands:
 
 ### Run Unit Tests
 
-Unit and Integration tests can be found in the `tests/` directory. You can run them with `make test`. Be sure to have `NIGHTFALL_TOKEN` and `NIGHTFALL_CONDITION_SET` set as environment variables before running the tests.
+Unit and Integration tests can be found in the `tests/` directory. You can run them with `pytest`. Be sure to have `NIGHTFALL_API_KEY` set as an environment variable before running the tests.
 
 ### View Code Coverage
 
 You can view the code coverage report by running `coverage html` and `python3 -m http.server --directory htmlcov` after running the unit tests.
 
-### SDK Documentation
-
-The SDK is documented using the Sphinx library. You can generatre the developer documentation using `make docs` and preview it on `localhost:8000` by running `make serve-docs`.
-
 ### Creating a Release 
 
 Releases are automatically published to PyPI using GitHub Actions. Creating a release in GitHub will trigger a new build that will publish the latest version of this library to [PyPI](https://pypi.org/project/nightfall/). 
 
 The steps to do this are: 
 
 1. Add what changed to the CHANGELOG file
-1. Update the version in `setup.py`
-1. Generate documentation with `make docs` to make sure it's up to date
+2. Update the version in `setup.py`
 3. Commit changes and push to the main branch. 
 4. Create a new release in the GitHub UI. 
 5. Observe the release action succeed and see the latest version of this library on PyPI. 

README.md

@@ -9,4 +9,7 @@ sphinx-autobuild
 sphinx_rtd_theme
 build
 flake8
-autopep8
+autopep8
+pytest
+pytest-cov
+requests