Skip to main content

Python API wrapper for the Cisco Support APIs.

devnet docs tests coverage pypi


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!

Metadata

Release files for ciscosupportsdk 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ciscosupportsdk 0.3.0
File Size Uploaded Provenance
ciscosupportsdk-0.3.0.tar.gz 25.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ciscosupportsdk 0.3.0
File Interpreter ABI Platform
ciscosupportsdk-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 58.6 kB

Release files / ciscosupportsdk-0.3.0.tar.gz

Download URL ciscosupportsdk-0.3.0.tar.gz
Size 25.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f62367485c753e32d72445ade1d096c5c9041177142a520c216c65e1e6d86195
BLAKE2b-256 checksum
How to use checksums
3715a12ffd20e051a7b8154777270d6008fb04b1bad29edefa74726bf9a5c7e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.16 Linux/6.17.0-1022-azure

Release files / ciscosupportsdk-0.3.0-py3-none-any.whl

Download URL ciscosupportsdk-0.3.0-py3-none-any.whl
Size 33.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d4745436fb7de475c90c601343e6fff8205bc9f50b00094d1debbc23323505df
BLAKE2b-256 checksum
How to use checksums
1443d9171dc6ce000fa920d04b592f1c8bb968d9728163ab15b1e70b1cd51205
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.16 Linux/6.17.0-1022-azure

Security for ciscosupportsdk 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page