| Name | CherwellAPIClient JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Zenoss API client module |
| upload_time | 2024-05-29 22:05:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
zenoss
monitoring
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Cherwell API Client
[](https://cherwellapiclient.readthedocs.io/en/latest/?badge=latest)
> NOTE: This module is inspired by the excellent [ZenossAPIClient](https://github.com/Zuora-TechOps/ZenossAPIClient) by Zuora-TechOps and the [fork](https://github.com/boblickj/ZenossAPIClient) contributed by boblickj.
>
> My own fork of that project is available via [PyPI as zenAPIClient](https://pypi.org/project/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)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "CherwellAPIClient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "zenoss, monitoring, api",
"author": null,
"author_email": "Dan Smalley <cherwellapiclient@smalley.link>",
"download_url": "https://files.pythonhosted.org/packages/48/b6/ba50473c22e72fbc6ea8fb652d10a5209f7a61f98b2fc43dbcd2987c91f5/cherwellapiclient-1.0.0.tar.gz",
"platform": null,
"description": "# Cherwell API Client\n\n \n[](https://cherwellapiclient.readthedocs.io/en/latest/?badge=latest) \n\n\n \n\n> NOTE: This module is inspired by the excellent [ZenossAPIClient](https://github.com/Zuora-TechOps/ZenossAPIClient) by Zuora-TechOps and the [fork](https://github.com/boblickj/ZenossAPIClient) contributed by boblickj.\n> \n> My own fork of that project is available via [PyPI as zenAPIClient](https://pypi.org/project/zenAPIClient/) \n> \n>-dan-smalley\n\nPython module for interacting with the Cherwell API in an object-oriented way.\nTested with API version 10.1.0, no guarantees for earlier versions...\n\nThe 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.\nThus `get` methods will always return an object, `list` methods will return data.\nAll methods to add or create start with `add`, all remove or delete start with `delete`.\nAs 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.\n\n## Installing\n\n```\npip install CherwellAPIClient\n```\n\n## Using\n\n```\nIn [1]: from cherwellapi import apiclient as capi\n\nIn [2]: cherwell_client = capi.Client(host=CHERWELL_URL, client_id=CLIENT_ID, username=USERNAME, passwrod=PASSWORD)\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Zenoss API client module",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://cherwellapiclient.readthedocs.io",
"Homepage": "https://github.com/dan-smalley/CherwellAPIClient",
"Repository": "https://github.com/dan-smalley/CherwellAPIClient.git"
},
"split_keywords": [
"zenoss",
" monitoring",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eef7a05cc02a0f74f0f5860b680a12350dd513093a6f2ebfb3a1fdb8f497163b",
"md5": "2706be10f752b33b2c41f6bca9268a2b",
"sha256": "995c9bcafc05c2af0e264dd7b9299047058d71654b2a3a10eb021952c71e3a62"
},
"downloads": -1,
"filename": "CherwellAPIClient-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2706be10f752b33b2c41f6bca9268a2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 13861,
"upload_time": "2024-05-29T22:05:48",
"upload_time_iso_8601": "2024-05-29T22:05:48.495229Z",
"url": "https://files.pythonhosted.org/packages/ee/f7/a05cc02a0f74f0f5860b680a12350dd513093a6f2ebfb3a1fdb8f497163b/CherwellAPIClient-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48b6ba50473c22e72fbc6ea8fb652d10a5209f7a61f98b2fc43dbcd2987c91f5",
"md5": "22393d3d7f8c6ac06936b3704b7c9c81",
"sha256": "cc128edc3cc36bf91967155408ff77342b50ea5b3afba2e56b0f5fe4c540a142"
},
"downloads": -1,
"filename": "cherwellapiclient-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "22393d3d7f8c6ac06936b3704b7c9c81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11813,
"upload_time": "2024-05-29T22:05:49",
"upload_time_iso_8601": "2024-05-29T22:05:49.720255Z",
"url": "https://files.pythonhosted.org/packages/48/b6/ba50473c22e72fbc6ea8fb652d10a5209f7a61f98b2fc43dbcd2987c91f5/cherwellapiclient-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-29 22:05:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dan-smalley",
"github_project": "CherwellAPIClient",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cherwellapiclient"
}
