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
Raw data
{
"_id": null,
"home_page": "https://supermanny81.github.io/ciscosupportapi/",
"name": "ciscosupportsdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "cisco,cisco-support,python-sdk",
"author": "Manny Garcia",
"author_email": "supermanny@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/a2/19/ae1ae033d6680442601b8a0579d82c3285bea39e120249698bae8babf91e/ciscosupportsdk-0.2.1.tar.gz",
"platform": null,
"description": "ciscosupportsdk\n===============\n\nPython API wrapper for the Cisco Support APIs.\n\n|devnet| |docs| |tests| |coverage| |pypi|\n\n----------------------------------------------\n\nThe **ciscosupportsdk** supports all of the Cisco Support API\ninteractions via a native Python library. This makes working with\nthese APIs a more *natural* experience and eases the burden of writing\nyour own boilerplate code to deal with API semantics, like authentication\nand pagination.\n\nFor detailed information and onboarding information, see the `support api`_\ndocumentation on DevNet. \n\nQuick Usage\n-----------\n.. code-block:: Python\n\n from ciscosupportsdk.api import CiscoSupportAPI\n\n api = CiscoSupportAPI(CS_API_KEY, CS_API_SECRET)\n\n # find if a serial number is covered and when it's warranty expires\n for item in api.serial_information.get_coverage_status(['FXS2130Q286']):\n print(f'{item.is_covered} {item.warranty_end_date}')\n\n\nFeatures\n--------\n* Represents all of the Cisco Support API interactions in native python\n * Authentication and connection management\n * All APIs organized hierarchically as attributes and methods under the main API object\n * Returned data objects are all native python objects\n* Pagination is automatic and transparent\n* API documentation will appear in your IDE to ease development\n\nInstallation\n------------\nInstalling and upgrading the **ciscosupportsdk** is easy with ``pip``\n\n.. code-block:: console\n\n pip install ciscosupportsdk\n # or to upgrade use...\n pip install ciscosupportsdk --upgrade\n\nIf you want to setup a development environment, use ``poetry`` instead:\n\n.. code-block:: console\n\n # Install poetry using pipx\n python -m pip install pipx\n python -m pipx ensurepath\n pipx install poetry\n\n # Clone repository\n git clone https://github.com/supermanny81/ciscosupportsdk.git\n cd ciscosupportsdk/\n\n # Install dependencies\n poetry install\n\n\nExamples\n--------\nLooking for some sample usage? Check out the examples_ folder!\n\n.. _support api: https://developer.cisco.com/docs/support-apis/\n.. |docs| image:: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/docs_to_pages.yaml/badge.svg \n :target: https://github.com/supermanny81/ciscosupportapi/actions/workflows/docs_to_pages.yaml\n.. |coverage| image:: https://codecov.io/gh/supermanny81/ciscosupportsdk/branch/master/graph/badge.svg?token=CU4V95TVF1\n :target: https://codecov.io/gh/supermanny81/ciscosupportapi\n.. |tests| image:: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/test.yaml/badge.svg\n :target: https://github.com/supermanny81/ciscosupportsdk/actions/workflows/test.yaml\n.. |pypi| image:: https://badge.fury.io/py/ciscosupportsdk.svg\n :target: https://badge.fury.io/py/ciscosupportsdk\n.. |devnet| image:: https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg\n :target: https://developer.cisco.com/codeexchange/github/repo/supermanny81/ciscosupportsdk\n.. _examples: https://github.com/supermanny81/ciscosupportsdk/tree/master/examples\n",
"bugtrack_url": null,
"license": "MIT",
"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.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://supermanny81.github.io/ciscosupportapi/",
"Repository": "https://github.com/supermanny81/ciscosupportapi"
},
"split_keywords": [
"cisco",
"cisco-support",
"python-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66039ff75578ed249342ed4f1f17d70d4f950a4fcd4a927dc9e23fb97b6e9285",
"md5": "100a59ed50dc0deb81271b20c25ddb07",
"sha256": "441322d70cc39d36c6754cc1ffa48cc08de493c383a7cd9120299bbd6084e160"
},
"downloads": -1,
"filename": "ciscosupportsdk-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "100a59ed50dc0deb81271b20c25ddb07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 25578,
"upload_time": "2023-09-27T03:02:29",
"upload_time_iso_8601": "2023-09-27T03:02:29.006191Z",
"url": "https://files.pythonhosted.org/packages/66/03/9ff75578ed249342ed4f1f17d70d4f950a4fcd4a927dc9e23fb97b6e9285/ciscosupportsdk-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a219ae1ae033d6680442601b8a0579d82c3285bea39e120249698bae8babf91e",
"md5": "a25b4c846b34e77a34dba15df0658585",
"sha256": "8e1e20d661088a15adbbd98f4ba08068a76f3f853e9aa04ebb111be981cbad7e"
},
"downloads": -1,
"filename": "ciscosupportsdk-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "a25b4c846b34e77a34dba15df0658585",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 17920,
"upload_time": "2023-09-27T03:02:30",
"upload_time_iso_8601": "2023-09-27T03:02:30.406323Z",
"url": "https://files.pythonhosted.org/packages/a2/19/ae1ae033d6680442601b8a0579d82c3285bea39e120249698bae8babf91e/ciscosupportsdk-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 03:02:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "supermanny81",
"github_project": "ciscosupportapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ciscosupportsdk"
}
JSON
