Skip to content

Commit 2d3adac

Browse files
authored
Update README.md
1 parent 7bd2a31 commit 2d3adac

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ This is a set of scripts that use these APIs to access and manage alerts. The sc
1111
## Requirements
1212

1313
- Python 3.10 or higher
14-
- Install dependencies with `python3 -mpip install -r requirements.txt`
15-
- Put a suitable GitHub token in your environment in `GITHUB_TOKEN`, for example with `GITHUB_TOKEN=$(gh auth token)` before the command
14+
- Install dependencies with `python3 -mpip install -r requirements.txt --user`
15+
- Consider using a virtualenv, managed by `pyenv`
16+
- On MacOS, add `--break-system-packages` to the end of the install command, if you are not using a virtualenv: `python3 -mpip install -r requirements.txt --user --break-system-packages`
17+
- Put a suitable GitHub token in your environment in `GITHUB_TOKEN`
18+
- for example with `GITHUB_TOKEN=$(gh auth token)` before the command
1619
- requires read access to GitHub Advanced Security alerts
1720
- requires read access to the repository, organization or Enterprise you are querying
1821
- Note that Secret Scanning alerts are only available to admins of the repository, organization or Enterprise, a security manager, or where explicitly enabled by the repository owner

0 commit comments

Comments
 (0)