Skip to main content

Zenoss API client module

Project description

Cherwell API Client

Tests badge Documentation Status PyPI - Version GitHub Release TestPyPI - Version

NOTE: This module is inspired by the excellent ZenossAPIClient by Zuora-TechOps and the fork contributed by boblickj.

My own fork of that project is available via PyPI as zenAPIClient

-dan-smalley

Python module for interacting with the Cherwell API in an object-oriented way. Tested with API version 10.1.0, no guarantees for earlier versions...

The philosophy here is to use objects to work with everything in the Cherwell API, and to try to normalize the various calls to the different routers. Thus get methods will always return an object, list methods will return data. All methods to add or create start with add, all remove or delete start with delete. As much as possible the methods try to hide the idiosyncrasies of the JSON API, and to do the work for you, for example by letting you use a device name instead of having to provide the full device UID for every call.

Installing

pip install CherwellAPIClient

Using

In [1]: from cherwellapi import apiclient as capi

In [2]: cherwell_client = capi.Client(host=CHERWELL_URL, client_id=CLIENT_ID, username=USERNAME, passwrod=PASSWORD)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cherwellapiclient-1.0.0.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

CherwellAPIClient-1.0.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file cherwellapiclient-1.0.0.tar.gz.

File metadata

  • Download URL: cherwellapiclient-1.0.0.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cherwellapiclient-1.0.0.tar.gz
Algorithm Hash digest
SHA256 cc128edc3cc36bf91967155408ff77342b50ea5b3afba2e56b0f5fe4c540a142
MD5 22393d3d7f8c6ac06936b3704b7c9c81
BLAKE2b-256 48b6ba50473c22e72fbc6ea8fb652d10a5209f7a61f98b2fc43dbcd2987c91f5

See more details on using hashes here.

File details

Details for the file CherwellAPIClient-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for CherwellAPIClient-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 995c9bcafc05c2af0e264dd7b9299047058d71654b2a3a10eb021952c71e3a62
MD5 2706be10f752b33b2c41f6bca9268a2b
BLAKE2b-256 eef7a05cc02a0f74f0f5860b680a12350dd513093a6f2ebfb3a1fdb8f497163b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page