Python library is an interface to the Xpanse Expander API.
Project description
![Xpanse](https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/blob/main/docs/_source/_static/xpanse_banner.png?raw=true|width=400)
[![Python versions](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blueviolet)](https://pypi.python.org/pypi/xpanse) [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![License](https://img.shields.io/pypi/l/xpanse)](https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/blob/main/LICENSE)
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](http://cortex-xpanse-python-sdk.readthedocs.io/en/latest/?badge=latest) [![GitHub contributors](https://img.shields.io/github/contributors/PaloAltoNetworks/cortex-xpanse-python-sdk)](https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/graphs/contributors)
Overview
This library is intended to be an interface to the Xpanse Expander API [Xpanse Expander API](https://knowledgebase.xpanse.co/expander-apis/>).
Install
pip install xpanse
Requirements
Python 3.6+
Usage
Documentation: https://cortex-xpanse-python-sdk.readthedocs.io/en/latest/
# Import client from xpanse.client import ExClient
# initialize client client = ExClient()
# get ip_range iterator object and dump to a list ranges = client.assets.ip_range.list().dump()
You can view more example code in the [examples directory](https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/tree/main/examples>).
Configuration
A valid Bearer token or JWT is required for use. Bearer tokens are suggested as JWTs have a limited lifespan.
RECOMMENDED
You can supply them as environment variables using the variable names XPANSE_BEARER_TOKEN and/or XPANSE_JWT_TOKEN.
export XPANSE_BEARER_TOKEN=<Bearer Token> # or export XPANSE_JWT_TOKEN=<JWT>
NOT RECOMMENDED
You can also provided these keys directly at client initialization by doing
client = ExClient(jwt=<JWT>) # or client = ExClient(bearer_token=<BearerToken>)
Logging
Logging is handled through the python logging package. To enable different levels of verbosity in your scripts you can do the following:
import logging logging.basicConfig(level=logging.DEBUG)
You can read more at https://docs.python.org/3/library/logging.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 Distribution
Built Distribution
Hashes for xpanse-1.0.9.post5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1b44ed17f31f20434f57260f62d9bd0688e18b1037b80e7d92581745920597a |
|
MD5 | f0430989c17246263c462ea299a168f7 |
|
BLAKE2b-256 | 8f76de428b22984da47471c79108ade9490f67005f435314decec18e39777075 |