semvec/pypi-packages huggingface dataset:
python-snyk-test 0.1.dev17
A package that wraps pysnyk library for easier usage from cli interfaces
License: MIT
Requires Python: >3.7

================
python-snyk-test
================

.. image:: screenshots/table_report.png
   :width: 640
   :alt: Table Report
   :target: screenshots/table_report.png



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 python-snyk-test --no-deps && pip install python-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 ``python-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::

    python-snyk-test package@version

For Example::

    $ python-snyk-test channels-redis@2.4.2


Development
===========

To run all the tests run::

    tox

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

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox


Changelog
=========

0.0.1 (2020-07-26)
------------------

* First release on PyPI.