Skip to content

Commit

Permalink
updated readme to include info about safety pkg
Browse files Browse the repository at this point in the history
updated readme to include info about safety pkg setup
  • Loading branch information
dlpbc committed Apr 18, 2024
1 parent 83ddbf1 commit 92b4c7a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,21 @@ poetry install
```

### Pre-commit

Run to make CI-tests pass
```bash
poetry run pre-commit run --all-files
```

Note: `SAFETY_API_KEY` environment variable needs to be set to run
the pre-commit hooks. Create an account with the [Safety package](https://platform.safetycli.com/)
and then navigate to Organization > API keys to fetch the key. Once
the key has been obtained, set the variable in your terminal using:

```bash
export SAFETY_API_KEY=your-api-key
```

## Examples
See [examples/app.py](examples/app.py) for a simple example.

Expand Down

0 comments on commit 92b4c7a

Please sign in to comment.