Welcome to pyTenable's documentation!
=====================================
.. image:: https://img.shields.io/pypi/v/pytenable.svg
.. image:: https://img.shields.io/badge/python-3.10%2B-blue
.. image:: https://img.shields.io/readthedocs/pytenable
.. image:: https://img.shields.io/pypi/dm/pytenable
.. image:: https://img.shields.io/github/license/tenable/pyTenable.svg
.. image:: https://sonarcloud.io/api/project_badges/measure?project=tenable_pyTenable&metric=alert_status
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
- Docs: https://pytenable.readthedocs.io
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(access_key='TIO_ACCESS_KEY', secret_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(url='https://SC_URL', access_key='AKEY', secret_key='SKEY')
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": null,
"name": "pyTenable",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "tenable, tenable vulnerability management, tenable security center, tenable securitycenter, tenable.io, tenable.sc, tenable.cs, tenable cloud security, tenable container security, tenable.ot, tenable ot security",
"author": "Tenable, Inc.",
"author_email": "Steve McGrath <smcgrath@tenable.com>",
"download_url": "https://files.pythonhosted.org/packages/be/00/7013eb91c846b20510b1962c5d29512ad9c7c825d70585870679a9bfe743/pytenable-1.8.4.tar.gz",
"platform": null,
"description": "Welcome to pyTenable's documentation!\n=====================================\n\n.. image:: https://img.shields.io/pypi/v/pytenable.svg\n.. image:: https://img.shields.io/badge/python-3.10%2B-blue\n.. image:: https://img.shields.io/readthedocs/pytenable\n.. image:: https://img.shields.io/pypi/dm/pytenable\n.. image:: https://img.shields.io/github/license/tenable/pyTenable.svg\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=tenable_pyTenable&metric=alert_status\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- Docs: https://pytenable.readthedocs.io\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(access_key='TIO_ACCESS_KEY', secret_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(url='https://SC_URL', access_key='AKEY', secret_key='SKEY')\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",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Python library to interface into Tenable's products and applications",
"version": "1.8.4",
"project_urls": {
"Changelog": "https://github.com/tenable/pytenable/blob/master/CHANGELOG.md",
"Homepage": "https://pytenable.readthedocs.io",
"Issues": "https://github.com/tenable/pytenable/issues",
"Repository": "https://github.com/tenable/pytenable"
},
"split_keywords": [
"tenable",
" tenable vulnerability management",
" tenable security center",
" tenable securitycenter",
" tenable.io",
" tenable.sc",
" tenable.cs",
" tenable cloud security",
" tenable container security",
" tenable.ot",
" tenable ot security"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a3f5a0b769866f9e7364f2b939ab65d798b0257021a72f41285d6348dcc2e560",
"md5": "5042b52241ff1028226a4e125194eaa6",
"sha256": "40b038a4082e2cdc227cf87ec076f8529a712d4b643e5f337b45c5b281c53f81"
},
"downloads": -1,
"filename": "pytenable-1.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5042b52241ff1028226a4e125194eaa6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 399978,
"upload_time": "2025-09-04T17:07:47",
"upload_time_iso_8601": "2025-09-04T17:07:47.833710Z",
"url": "https://files.pythonhosted.org/packages/a3/f5/a0b769866f9e7364f2b939ab65d798b0257021a72f41285d6348dcc2e560/pytenable-1.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "be007013eb91c846b20510b1962c5d29512ad9c7c825d70585870679a9bfe743",
"md5": "3b8dfe86da3f3202b9045644bfffb098",
"sha256": "3d6c78e9448610bac271b167f655f1e824136c705eb6fdda1cd6ff05e14f76f0"
},
"downloads": -1,
"filename": "pytenable-1.8.4.tar.gz",
"has_sig": false,
"md5_digest": "3b8dfe86da3f3202b9045644bfffb098",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 276051,
"upload_time": "2025-09-04T17:07:49",
"upload_time_iso_8601": "2025-09-04T17:07:49.654112Z",
"url": "https://files.pythonhosted.org/packages/be/00/7013eb91c846b20510b1962c5d29512ad9c7c825d70585870679a9bfe743/pytenable-1.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 17:07:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tenable",
"github_project": "pytenable",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pytenable"
}
JSON
