| Name | ua-clarity-api JSON |
| Version |
1.1.6
JSON |
| download |
| home_page | |
| Summary | Provides a simple REST implementation for use with Clarity endpoints. |
| upload_time | 2024-01-11 19:11:42 |
| maintainer | |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UA-Clarity-API
Provides a simple REST implementation for use with Clarity endpoints.
## Motivation
Was designed to implement a simple way to interact with Clarity REST architecture.
## Features
- Get will do a batch get if that end point exists, otherwise it will return a response similar to what a batch get returns.
- Caller can add queries to get using a keyword.
- Caches every get to eliminate excessive get calls.
- All REST calls will throw an exception if they failed.
## Code Example
```python
from ua_clarity_api import ua_clarity_api
api = ua_clarity_api.ClarityApi(host, username, password)
uris_files = api.download_files("some file uri")
data = api.get("some endpoint")
```
## Installation
```bash
pip install ua-clarity-api
```
## Tests
```bash
pip install --update nose
cd ./repo
cd ./tests
nosetests test_ua_clarity_api.py
```
## How to Use
- You'll need to instantiate a ClarityApi object with a correct host, and the username/password to access that host's endpoints.
- Get can retrieve resources from endpoints and can utilize queries with the "parameters" keyword.
- Put and Post can update or create new resources given the appropriate endpoint and a well-formed payload.
- Delete can remove a resource from an endpoint.
- Download_files will create temporary files from a list of file uris and returns them as a dictionary mapping of uri: tempfile.
## Credits
[sterns1](https://github.com/sterns1)
[raflopjr](https://github.com/raflopjr)
[RyanJohannesBland](https://github.com/RyaJohannesBland)
## License
MIT
Raw data
{
"_id": null,
"home_page": "",
"name": "ua-clarity-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/ea/e9/02fabef493b6de22d98f09619ea87a4dbff00487b5b1186c8307ba923d77/ua_clarity_api-1.1.6.tar.gz",
"platform": null,
"description": "# UA-Clarity-API\n\nProvides a simple REST implementation for use with Clarity endpoints.\n\n## Motivation\n\nWas designed to implement a simple way to interact with Clarity REST architecture.\n\n## Features\n\n- Get will do a batch get if that end point exists, otherwise it will return a response similar to what a batch get returns.\n- Caller can add queries to get using a keyword.\n- Caches every get to eliminate excessive get calls.\n- All REST calls will throw an exception if they failed.\n\n## Code Example\n\n```python\nfrom ua_clarity_api import ua_clarity_api\n\n\napi = ua_clarity_api.ClarityApi(host, username, password)\nuris_files = api.download_files(\"some file uri\")\ndata = api.get(\"some endpoint\")\n```\n\n## Installation\n\n```bash\npip install ua-clarity-api\n```\n\n## Tests\n\n```bash\npip install --update nose\ncd ./repo\ncd ./tests\nnosetests test_ua_clarity_api.py\n```\n\n## How to Use\n\n- You'll need to instantiate a ClarityApi object with a correct host, and the username/password to access that host's endpoints.\n- Get can retrieve resources from endpoints and can utilize queries with the \"parameters\" keyword.\n- Put and Post can update or create new resources given the appropriate endpoint and a well-formed payload.\n- Delete can remove a resource from an endpoint.\n- Download_files will create temporary files from a list of file uris and returns them as a dictionary mapping of uri: tempfile.\n\n## Credits\n\n[sterns1](https://github.com/sterns1)\n[raflopjr](https://github.com/raflopjr)\n[RyanJohannesBland](https://github.com/RyaJohannesBland)\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "",
"summary": "Provides a simple REST implementation for use with Clarity endpoints.",
"version": "1.1.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9a6f40d39fc7ba72f7315381ab0e30b0309617839382cc9a5b8016a5351c3b5",
"md5": "90a08a081f9f8ee2f71db51e64606a42",
"sha256": "bf818b58fe1ca391ed8305bd0d150efd599f4a5704ddec1729c3344991ddf008"
},
"downloads": -1,
"filename": "ua_clarity_api-1.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90a08a081f9f8ee2f71db51e64606a42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 9441,
"upload_time": "2024-01-11T19:11:41",
"upload_time_iso_8601": "2024-01-11T19:11:41.061169Z",
"url": "https://files.pythonhosted.org/packages/d9/a6/f40d39fc7ba72f7315381ab0e30b0309617839382cc9a5b8016a5351c3b5/ua_clarity_api-1.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eae902fabef493b6de22d98f09619ea87a4dbff00487b5b1186c8307ba923d77",
"md5": "4d495bedf5452c0d65e248487b035cdc",
"sha256": "dd580b8bd8e5eaf05807074f71a93f6d98f5cea3cc02a04d7f90b146bfb02eef"
},
"downloads": -1,
"filename": "ua_clarity_api-1.1.6.tar.gz",
"has_sig": false,
"md5_digest": "4d495bedf5452c0d65e248487b035cdc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 8036,
"upload_time": "2024-01-11T19:11:42",
"upload_time_iso_8601": "2024-01-11T19:11:42.723043Z",
"url": "https://files.pythonhosted.org/packages/ea/e9/02fabef493b6de22d98f09619ea87a4dbff00487b5b1186c8307ba923d77/ua_clarity_api-1.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-11 19:11:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ua-clarity-api"
}
