Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Just to make it even easier to get going #109

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Just to make it even easier to get going #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ A Python client for the [Snyk API](https://snyk.docs.apiary.io/#).

Using the client requires you to provide your Snyk API token.

```bash
pip3 install snyk
Copy link
Contributor

@ig596 ig596 Nov 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a poetry project. I would also recommend including the appropriate poetry command as well.
poetry install pysnyk or poetry add pysnyk

```

Or add to your requirements.txt file and run:
```
pip3 install -r requirements.txt
```

Then:

```python
import snyk
client = snyk.SnykClient("<your-api-token>")
Expand Down