Metadata-Version: 2.1
Name: ciscosupportsdk
Version: 0.2.2
Summary: 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.
Home-page: https://supermanny81.github.io/ciscosupportapi/
License: MIT
Keywords: cisco,cisco-support,python-sdk
Author: Manny Garcia
Author-email: supermanny@icloud.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: docs
Requires-Dist: Authlib (>=1.2.1,<2.0.0)
Requires-Dist: pydantic (>=1.9.0,<2.0.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Project-URL: Repository, https://github.com/supermanny81/ciscosupportapi
Description-Content-Type: text/x-rst

ciscosupportsdk
===============

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
-----------
.. code-block:: Python

   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``

.. code-block:: console

   pip install ciscosupportsdk
   # or to upgrade use...
   pip install ciscosupportsdk --upgrade

If you want to setup a development environment, use ``poetry`` instead:

.. code-block:: console

   # 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!

.. _support api: https://developer.cisco.com/docs/support-apis/
.. |docs| image:: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/docs_to_pages.yaml/badge.svg 
   :target: https://github.com/supermanny81/ciscosupportapi/actions/workflows/docs_to_pages.yaml
.. |coverage| image:: https://codecov.io/gh/supermanny81/ciscosupportsdk/branch/master/graph/badge.svg?token=CU4V95TVF1
   :target: https://codecov.io/gh/supermanny81/ciscosupportapi
.. |tests| image:: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/test.yaml/badge.svg
   :target: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/test.yaml
.. |pypi| image:: https://badge.fury.io/py/ciscosupportsdk.svg
   :target: https://badge.fury.io/py/ciscosupportsdk
.. |devnet| image:: https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg
   :target: https://developer.cisco.com/codeexchange/github/repo/supermanny81/ciscosupportsdk
.. _examples: https://github.com/supermanny81/ciscosupportsdk/tree/master/examples

