Welcome to pyTenable's documentation!
=====================================
.. image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ftenable%2FpyTenable%2Fbadge&label=build
:target: https://github.com/tenable/pyTenable/actions
.. image:: https://img.shields.io/pypi/v/pytenable.svg
:target: https://pypi.org/project/pyTenable/
.. image:: https://img.shields.io/badge/python-3.7%203.8%203.9%203.10%203.11-blue
:target: https://pypi.org/project/pyTenable/
.. image:: https://img.shields.io/pypi/dm/pytenable
:target: https://github.com/tenable/pytenable
.. image:: https://img.shields.io/github/license/tenable/pyTenable.svg
:target: https://github.com/tenable/pytenable
.. image:: https://sonarcloud.io/api/project_badges/measure?project=tenable_pyTenable&metric=alert_status
:target: https://sonarcloud.io/project/overview?id=tenable_pyTenable
pyTenable is intended to be a pythonic interface into the Tenable application
APIs. Further by providing a common interface and a common structure between
all of the various applications, we can ease the transition from the vastly
different APIs between some of the products.
- Issue Tracker: https://github.com/tenable/pyTenable/issues
- Github Repository: https://github.com/tenable/pyTenable
Installation
------------
To install the most recent published version to pypi, its simply a matter of
installing via pip:
.. code-block:: bash
pip install pytenable
If you're looking for bleeding-edge, then feel free to install directly from the
github repository like so:
.. code-block:: bash
pip install git+git://github.com/tenable/pytenable.git#egg=pytenable
Getting Started
---------------
Lets assume that we want to get the list of scans that have been run on our
Tenable.io application. Performing this action is as simple as the following:
.. code-block:: python
from tenable.io import TenableIO
tio = TenableIO('TIO_ACCESS_KEY', 'TIO_SECRET_KEY')
for scan in tio.scans.list():
print('{status}: {id}/{uuid} - {name}'.format(**scan))
Getting started with Tenable.sc is equally as easy:
.. code-block:: python
from tenable.sc import TenableSC
sc = TenableSC('SECURITYCENTER_NETWORK_ADDRESS')
sc.login('SC_USERNAME', 'SC_PASSWORD')
for vuln in sc.analysis.vulns():
print('{ip}:{pluginID}:{pluginName}'.format(**vuln))
For more detailed information on whats available, please refer to the
`pyTenable Documentation <https://pytenable.readthedocs.io/>`_
Logging
-------
Enabling logging for pyTenable is a simple matter of enabling debug logs through
the python logging package. An easy example is detailed here:
.. code-block:: python
import logging
logging.basicConfig(level=logging.DEBUG)
License
-------
The project is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/tenable/pytenable",
"name": "pyTenable",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "tenable tenable_io securitycenter containersecurity",
"author": "Tenable, Inc.",
"author_email": "smcgrath@tenable.com",
"download_url": "https://files.pythonhosted.org/packages/2e/03/5e738bfeb4ecc3dad08ff5dc1bf712e8ad62b69de9c0d27e27dcc12f9554/pyTenable-1.4.20.tar.gz",
"platform": null,
"description": "Welcome to pyTenable's documentation!\n=====================================\n\n.. image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ftenable%2FpyTenable%2Fbadge&label=build\n :target: https://github.com/tenable/pyTenable/actions\n.. image:: https://img.shields.io/pypi/v/pytenable.svg\n :target: https://pypi.org/project/pyTenable/\n.. image:: https://img.shields.io/badge/python-3.7%203.8%203.9%203.10%203.11-blue\n :target: https://pypi.org/project/pyTenable/\n.. image:: https://img.shields.io/pypi/dm/pytenable\n :target: https://github.com/tenable/pytenable\n.. image:: https://img.shields.io/github/license/tenable/pyTenable.svg\n :target: https://github.com/tenable/pytenable\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=tenable_pyTenable&metric=alert_status\n :target: https://sonarcloud.io/project/overview?id=tenable_pyTenable\n\npyTenable is intended to be a pythonic interface into the Tenable application\nAPIs. Further by providing a common interface and a common structure between\nall of the various applications, we can ease the transition from the vastly\ndifferent APIs between some of the products.\n\n- Issue Tracker: https://github.com/tenable/pyTenable/issues\n- Github Repository: https://github.com/tenable/pyTenable\n\nInstallation\n------------\n\nTo install the most recent published version to pypi, its simply a matter of\ninstalling via pip:\n\n.. code-block:: bash\n\n pip install pytenable\n\nIf you're looking for bleeding-edge, then feel free to install directly from the\ngithub repository like so:\n\n.. code-block:: bash\n\n pip install git+git://github.com/tenable/pytenable.git#egg=pytenable\n\nGetting Started\n---------------\n\nLets assume that we want to get the list of scans that have been run on our\nTenable.io application. Performing this action is as simple as the following:\n\n.. code-block:: python\n\n from tenable.io import TenableIO\n tio = TenableIO('TIO_ACCESS_KEY', 'TIO_SECRET_KEY')\n for scan in tio.scans.list():\n print('{status}: {id}/{uuid} - {name}'.format(**scan))\n\nGetting started with Tenable.sc is equally as easy:\n\n.. code-block:: python\n\n from tenable.sc import TenableSC\n sc = TenableSC('SECURITYCENTER_NETWORK_ADDRESS')\n sc.login('SC_USERNAME', 'SC_PASSWORD')\n for vuln in sc.analysis.vulns():\n print('{ip}:{pluginID}:{pluginName}'.format(**vuln))\n\nFor more detailed information on whats available, please refer to the\n`pyTenable Documentation <https://pytenable.readthedocs.io/>`_\n\nLogging\n-------\n\nEnabling logging for pyTenable is a simple matter of enabling debug logs through\nthe python logging package. An easy example is detailed here:\n\n.. code-block:: python\n\n import logging\n logging.basicConfig(level=logging.DEBUG)\n\nLicense\n-------\n\nThe project is licensed under the MIT license.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library to interface into Tenable's products and applications",
"version": "1.4.20",
"project_urls": {
"Homepage": "https://github.com/tenable/pytenable"
},
"split_keywords": [
"tenable",
"tenable_io",
"securitycenter",
"containersecurity"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8df644eca16d384d11015c13a39aced65a3910a47d4ce2e1b8ebf137be6e2bf0",
"md5": "e2928a9de168884639bd08a664a5a0df",
"sha256": "f52393e01c3279857e4a15f808ee6598a10ab2309b933cf5124a2d6755761dae"
},
"downloads": -1,
"filename": "pyTenable-1.4.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2928a9de168884639bd08a664a5a0df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 311000,
"upload_time": "2024-02-14T02:21:25",
"upload_time_iso_8601": "2024-02-14T02:21:25.373984Z",
"url": "https://files.pythonhosted.org/packages/8d/f6/44eca16d384d11015c13a39aced65a3910a47d4ce2e1b8ebf137be6e2bf0/pyTenable-1.4.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e035e738bfeb4ecc3dad08ff5dc1bf712e8ad62b69de9c0d27e27dcc12f9554",
"md5": "1df2c51132ab819b6c0fb2d43e454d6a",
"sha256": "9e496d56286c8ea50dd2c38fbc0d9a9c28b9d536a6e31ea303e5d69e243d65ef"
},
"downloads": -1,
"filename": "pyTenable-1.4.20.tar.gz",
"has_sig": false,
"md5_digest": "1df2c51132ab819b6c0fb2d43e454d6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 215771,
"upload_time": "2024-02-14T02:21:30",
"upload_time_iso_8601": "2024-02-14T02:21:30.178755Z",
"url": "https://files.pythonhosted.org/packages/2e/03/5e738bfeb4ecc3dad08ff5dc1bf712e8ad62b69de9c0d27e27dcc12f9554/pyTenable-1.4.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 02:21:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tenable",
"github_project": "pytenable",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "pytenable"
}
JSON
