Tenable.io API SDK
Project description
NOTICE: Tenable.io SDK for Python is being deprecated in favor of pyTenable
Tenable has decided to deprecate the tenable_io package in favor of the more widely used library, pyTenable. pyTenable offers all of the same functionality as this package, as well as support for tenable.sc. However, it should be noted that pyTenable functions are not compatible with tenable_io functions. Sunset for support with be on August 1, 2020.
Original README
Tenable.io SDK for Python
Welcome to the Tenable.io SDK for Python. This library can be used to easily integrate with the tenable.io API.
For you coffee lovers, check out Tenable.io SDK for Java.
Report any issues here.
Additional documentation is available in our Developer Portal.
Installation
$ pip install tenable_io
Quick Start
Quickest way to get started is to checkout the example scripts.
Configuration
Access key and secret key are needed to authenticate with the Tenable Cloud API. There are three ways to supply the keys to the TenableIOClient:
Precedence |
Method |
---|---|
1 |
Constructor Arguments |
2 |
INI File |
3 |
Environment Variables |
TenableIOClient Constructor Arguments
TenableIOClient(access_key='YOUR_ACCESS_KEY', secret_key='YOUR_SECRET_KEY')
INI File
Environment Variables
TenableIOClient looks for the environment variables TENABLEIO_ACCESS_KEY and TENABLEIO_SECRET_KEY.
Python Version
2.7, 3.4+
Development
It is recommend to use virtualenv to setup an isolated local environment.
$ virtualenv .venv
# To use a different python bin (i.e. python3).
$ virtualenv .venv3 -p $(which python3)
# To active the virtualenv
$ source ./.venv/bin/activate
Install dependencies.
$ pip install -r ./requirements.txt
$ pip install -r ./requirements-build.txt
Run Tests
Additional configuration is needed for tests to correctly run. See the [tenable_io-test] section under tenable_io.ini.example. Such configuration can be done via the INI file tenable_io.ini or environment variables.
$ py.test
Documentations
To generate/force update the RST documentations from docstrings.
$ sphinx-apidoc -f -o doc/source tenable_io
Generate HTML documentation.
$ cd doc
$ make clean && make html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for tenable_io-1.13.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1900ce0c2101d12ef31da1d13b0f9f4369c83ffca333feb870e0ce1ac7112e17 |
|
MD5 | f6a330deb334da0a4809ec7e252a55c8 |
|
BLAKE2b-256 | e77377cbb688031cd2b41441bf3cd4d7492494bc6682fe3d36b597092af3087b |