{ "info": { "author": "Gareth Rushgrove", "author_email": "gareth@morethanseven.net", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7" ], "description": "# Snyk Shell\n\nSnyk Shell provides a convenient shell interface to the Snyk API. You can\nuse any valid Python expression as well as make calls to the Snyk API using\nthe pre-configured Snyk API client. When you load the the shell it will\npre-load a list of your organizations and projects so you have some data to explore.\n\n## Installation\n\nSnyk Shell is available from PyPi. Use your prefered Python dependency management tool to install:\n\n```\npip install snyksh\n```\n\nSnyk Shell is also available as a Docker image.\n\n```\ndocker pull garethr/snyksh\n```\n\n## Configuration\n\nIn order to access the Snyk API you need to provide your API token. This is done using\nan environment variable called `SNYK_TOKEN`:\n\n```\nexport SNYK_TOKEN=\nsnyksh\n```\n\n```\ndocker run --rm -it -e SNYK_TOKEN= garethr/snyksh\n```\n\n## Usage\n\nWith Snyk Shell running you can interact with data in Snyk. This includes your projects as\nwell as vulnerability data more generally.\n\nHere's a few examples.\n\n```ipython\nWelcome to Snyk Shell\n\nThe following objects and methods are currently available:\n client - An instance of the Snyk client, which can be used to make requests to the API\n organizations - A prepopulated list of the Snyk organizations you are a member of\n projects - A prepopulated list of all of your Snyk projects\n pprint() - A pretty printer for objects returns by the API\n\n\nIn [1]: organizations\nOut[1]: [Organization(name='garethr', id='', group=None)]\n\nIn [2]: pprint(organizations)\n[\n snyk.models.Organization(\n name='garethr',\n id=''\n )\n]\n\nIn [3]: results = client.organizations.first().test_python(\"django\", \"2.0.0\")\n\nIn [4]: len(results.issues.vulnerabilities)\nOut[4]: 6\n\nIn [5]: [x.identifiers[\"CVE\"][0] for x in results.issues.vulnerabilities]\nOut[5]:\n['CVE-2019-6975',\n 'CVE-2018-7536',\n 'CVE-2018-7537',\n 'CVE-2018-6188',\n 'CVE-2018-14574',\n 'CVE-2019-3498']\n```\n\n## The Snyk API client\n\nSnyk Shell uses the Snyk Python API client `pysnyk`. If you want to build your own applications\nwhich interact with the Snyk API, or you want to know all of the properties and methods avaiable\nto you, see the client documentation and examples.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/garethr/snyksh", "keywords": "", "license": "MIT", "maintainer": "Gareth Rushgrove", "maintainer_email": "gareth@morethanseven.net", "name": "snyksh", "package_url": "https://pypi.org/project/snyksh/", "platform": "", "project_url": "https://pypi.org/project/snyksh/", "project_urls": { "Homepage": "https://github.com/garethr/snyksh", "Repository": "https://github.com/garethr/snyksh" }, "release_url": "https://pypi.org/project/snyksh/0.1.0/", "requires_dist": [ "pysnyk", "termcolor", "ipython", "prettyprinter" ], "requires_python": ">=3.7,<4.0", "summary": "An interactive shell interface for the Snyk API", "version": "0.1.0" }, "last_serial": 5536031, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "b49c0a0971eb51fc5f7d2ceddd9759c0", "sha256": "707fabec1f33bfc0ce2856addb4d81e05a01640d508d9bc92e9224a21cb2214f" }, "downloads": -1, "filename": "snyksh-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "b49c0a0971eb51fc5f7d2ceddd9759c0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 3846, "upload_time": "2019-07-15T17:08:41", "url": "https://files.pythonhosted.org/packages/c2/57/6b042f361b7db864d948f8a65b4f8237fce684f390018a5368309444f378/snyksh-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5dde250893d2ce2eb21f522d60cd691f", "sha256": "8cb3d24fefb79f3a22d8267fffb8b86bf2bb463312202ac4b08928bf05d9d25f" }, "downloads": -1, "filename": "snyksh-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5dde250893d2ce2eb21f522d60cd691f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 3520, "upload_time": "2019-07-15T17:08:43", "url": "https://files.pythonhosted.org/packages/77/f8/18b398d85e8e079ce88f135f9a280709848a3bf0d1b0e86be50c713170d7/snyksh-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b49c0a0971eb51fc5f7d2ceddd9759c0", "sha256": "707fabec1f33bfc0ce2856addb4d81e05a01640d508d9bc92e9224a21cb2214f" }, "downloads": -1, "filename": "snyksh-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "b49c0a0971eb51fc5f7d2ceddd9759c0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 3846, "upload_time": "2019-07-15T17:08:41", "url": "https://files.pythonhosted.org/packages/c2/57/6b042f361b7db864d948f8a65b4f8237fce684f390018a5368309444f378/snyksh-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5dde250893d2ce2eb21f522d60cd691f", "sha256": "8cb3d24fefb79f3a22d8267fffb8b86bf2bb463312202ac4b08928bf05d9d25f" }, "downloads": -1, "filename": "snyksh-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5dde250893d2ce2eb21f522d60cd691f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 3520, "upload_time": "2019-07-15T17:08:43", "url": "https://files.pythonhosted.org/packages/77/f8/18b398d85e8e079ce88f135f9a280709848a3bf0d1b0e86be50c713170d7/snyksh-0.1.0.tar.gz" } ] }