From 6a3ace6e19705d0ce0cbcaa6cc7f5481d46f05c3 Mon Sep 17 00:00:00 2001 From: Troy Connor Date: Wed, 20 Oct 2021 16:18:36 -0400 Subject: [PATCH] fix: add dependencies to requirements.txt and fix readme to use automation.py instead of export_report.py --- .gitignore | 3 ++- README.md | 20 +++++++++++++++----- requirements.txt | 4 +++- 3 files changed, 20 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index de40e7b..2b24d54 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # DevEnv .vscode +/env* # App ocm-load-test config.yaml @@ -9,4 +10,4 @@ build release # GDriveAPI credentials.json -token.pickle \ No newline at end of file +token.pickle diff --git a/README.md b/README.md index 7a8f9ca..f5ef9e1 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ See [example](./config.example.yaml) ## Reporting -### Rquirements +### Requirements #### External @@ -126,28 +126,38 @@ See [example](./config.example.yaml) #### python requirements -`$ pip3 install -r requirements.txt` +```bash +$ python3 -m venv env +$ . ./env/bin/activate +$ pip3 install -r requirements.txt +``` ### Usage To generate the report run the following command: -`python3 export_report.py /tests/2021-05-18` +`python3 automation.py --dir /tests/2021-05-18` The first argument should be the path to the folder where the `results` folder is located. ### Graph a specific file -`python3 export_report.py graph /tests/2021-05-18/results/access_review.json` +`python3 automation.py graph --dir /tests/2021-05-18/results/ --filename access_review.json` This should open the browser with an interactive Graph for access review. ### Generate `vegeta` reports -`python3 export_report.py report /tests/2021-05-18` +`python3 automation.py report --dir /tests/2021-05-18` This will generate all the `vegeta` report files for each result file +When done deactivate virtual environment + +```bash +$ deactivate +``` + ## How to release Steps: diff --git a/requirements.txt b/requirements.txt index 833f57a..be3c74d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,7 @@ plotly pandas python-docx +requests +kaleido sqlalchemy -elasticsearch \ No newline at end of file +elasticsearch