Cisco Support APIs allow Cisco Partner Support Services (PSS) partners and Cisco Smart Net Total Care (SNTC) customers to programmatically access and consume Cisco Support data in the cloud in a simple, secure, and scalable manner.
Project description
Python API wrapper for the Cisco Support APIs.
The ciscosupportsdk supports all of the Cisco Support API interactions via a native Python library. This makes working with these APIs a more natural experience and eases the burden of writing your own boilerplate code to deal with API semantics, like authentication and pagination.
For detailed information and onboarding information, see the support api documentation on DevNet.
Quick Usage
from ciscosupportsdk.api import CiscoSupportAPI
api = CiscoSupportAPI(CS_API_KEY, CS_API_SECRET)
# find if a serial number is covered and when it's warranty expires
for item in api.serial_information.get_coverage_status(['FXS2130Q286']):
print(f'{item.is_covered} {item.warranty_end_date}')
Features
- Represents all of the Cisco Support API interactions in native python
Authentication and connection management
All APIs organized hierarchically as attributes and methods under the main API object
Returned data objects are all native python objects
Pagination is automatic and transparent
API documentation will appear in your IDE to ease development
Installation
Installing and upgrading the ciscosupportsdk is easy with pip
pip install ciscosupportsdk
# or to upgrade use...
pip install ciscosupportsdk --upgrade
If you want to setup a development environment, use poetry instead:
# Install poetry using pipx
python -m pip install pipx
python -m pipx ensurepath
pipx install poetry
# Clone repository
git clone https://github.com/supermanny81/ciscosupportsdk.git
cd ciscosupportsdk/
# Install dependencies
poetry install
Examples
Looking for some sample usage? Check out the examples folder!
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 ciscosupportsdk-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 441322d70cc39d36c6754cc1ffa48cc08de493c383a7cd9120299bbd6084e160 |
|
MD5 | 100a59ed50dc0deb81271b20c25ddb07 |
|
BLAKE2b-256 | 66039ff75578ed249342ed4f1f17d70d4f950a4fcd4a927dc9e23fb97b6e9285 |