Overview

docs
tests
package

A package that wraps pysnyk library for easier usage from cli interfaces

• Free software: MIT license

Installation

$ brew reinstall readline xz # OSX only
If you're using pyenv, reinstall it # OSX only

Then install the package using pip

pip install snyk-test

You can also install the in-development version with:

pip install https://github.com/avishayil/python-snyk-test/archive/master.zip

Documentation

First, before using snyk-test you must authenticate with snyk using snyk auth Then, alter your $HOME/.config/configstore/snyk.json and add the org_id parameter to the JSON file using the following command:

$ snyk config set org_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx # Your organization ID

The JSON file will look as follows:

{
        "api": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "org_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Then, after all the prerequisites are met, run the the following command from your terminal:

snyk-test package@version

For Example:

$ snyk-test [email protected]

Documentation

https://python-snyk-test.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox