Skip to content

Commit

Permalink
fix: add dependencies to requirements.txt and fix readme to use autom…
Browse files Browse the repository at this point in the history
…ation.py instead of export_report.py
  • Loading branch information
troy0820 committed Oct 20, 2021
1 parent 9fdd829 commit 6a3ace6
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# DevEnv
.vscode
/env*
# App
ocm-load-test
config.yaml
Expand All @@ -9,4 +10,4 @@ build
release
# GDriveAPI
credentials.json
token.pickle
token.pickle
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ See [example](./config.example.yaml)
## Reporting
### Rquirements
### Requirements
#### External
Expand All @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
plotly
pandas
python-docx
requests
kaleido
sqlalchemy
elasticsearch
elasticsearch

0 comments on commit 6a3ace6

Please sign in to comment.