| Name | waylay-sdk-queries-types JSON |
| Version |
0.5.0.20240809
JSON |
| download |
| home_page | None |
| Summary | Waylay Query: timeseries queries (v1 protocol) Types |
| upload_time | 2024-08-09 09:11:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | ISC License (ISC) Copyright 2024, Waylay Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| keywords |
waylay query: timeseries queries (v1 protocol)
types
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Waylay Queries Service
Execute and store queries on the Waylay timeseries.
Protocol version: v1.
This Python package is automatically generated based on the
Waylay Queries OpenAPI specification (API version: 0.5.0)
For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/queries.html).
It is considered an extension of the waylay-sdk-queries package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in `waylay-sdk-queries`.
## Requirements.
This package requires Python 3.9+.
## Installation
Normally this package is installed together with support for other services using the [waylay-sdk](https://pypi.org/project/waylay-sdk/) umbrella package:
* `pip install waylay-sdk` will install `waylay-sdk-queries` together with the SDK api packages for other services.
* `pip install waylay-sdk[types-queries]` will additionally install the types package `waylay-sdk-queries-types`.
* `pip install waylay-sdk[types]` will install the types packages for this and all other services.
Alternatively, you can install support for this _queries_ service only, installing or extending an existing [waylay-sdk-core](https://pypi.org/project/waylay-sdk-core/):
- `pip install waylay-sdk-queries` to only install api support for _queries_.
- `pip install waylay-sdk-queries[types]` to additionally install type support for _queries_.
## Usage
```python
from pprint import pprint
# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError
# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()
# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-queries-types` is installed
from waylay.services.queries.models.query_input import QueryInput
from waylay.services.queries.models.query_result import QueryResult
try:
# Execute Query
# calls `POST /queries/v1/data`
api_response = await waylay_client.queries.execute.execute(
# query parameters:
query = {
'resource': '13efb488-75ac-4dac-828a-d49c5c2ebbfc'
'metric': 'temperature'
},
# json data: use a generated model or a json-serializable python data structure (dict, list)
json = waylay.services.queries.QueryInput() # QueryInput |
headers = {
'accept': 'accept_example',
},
)
print("The response of queries.execute.execute:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling queries.execute.execute: %s\n" % e)
```
For more information, please visit the [Waylay API documentation](https://docs.waylay.io/#/api/?id=software-development-kits).
Raw data
{
"_id": null,
"home_page": null,
"name": "waylay-sdk-queries-types",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Waylay Query: timeseries queries (v1 protocol), Types",
"author": null,
"author_email": "Waylay <info@waylay.io>",
"download_url": "https://files.pythonhosted.org/packages/8c/2a/40b93bb3d2820f58d9872899e85d53a80e9b0a54e7162751cbe80f6aa510/waylay_sdk_queries_types-0.5.0.20240809.tar.gz",
"platform": null,
"description": "# Waylay Queries Service\n\nExecute and store queries on the Waylay timeseries.\n\nProtocol version: v1.\n\nThis Python package is automatically generated based on the \nWaylay Queries OpenAPI specification (API version: 0.5.0)\nFor more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/queries.html).\n\nIt is considered an extension of the waylay-sdk-queries package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in `waylay-sdk-queries`.\n\n## Requirements.\nThis package requires Python 3.9+.\n\n## Installation\n\nNormally this package is installed together with support for other services using the [waylay-sdk](https://pypi.org/project/waylay-sdk/) umbrella package:\n* `pip install waylay-sdk` will install `waylay-sdk-queries` together with the SDK api packages for other services.\n* `pip install waylay-sdk[types-queries]` will additionally install the types package `waylay-sdk-queries-types`.\n* `pip install waylay-sdk[types]` will install the types packages for this and all other services.\n\nAlternatively, you can install support for this _queries_ service only, installing or extending an existing [waylay-sdk-core](https://pypi.org/project/waylay-sdk-core/):\n\n- `pip install waylay-sdk-queries` to only install api support for _queries_.\n- `pip install waylay-sdk-queries[types]` to additionally install type support for _queries_.\n\n## Usage\n\n```python\nfrom pprint import pprint\n\n# Import the waylay-client from the waylay-sdk-core package\nfrom waylay.sdk.client import WaylayClient\nfrom waylay.sdk.api.api_exceptions import ApiError\n\n# Intialize a waylay client instance\nwaylay_client = WaylayClient.from_profile()\n\n# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-queries-types` is installed\nfrom waylay.services.queries.models.query_input import QueryInput\nfrom waylay.services.queries.models.query_result import QueryResult\ntry:\n # Execute Query\n # calls `POST /queries/v1/data`\n api_response = await waylay_client.queries.execute.execute(\n # query parameters:\n query = {\n 'resource': '13efb488-75ac-4dac-828a-d49c5c2ebbfc'\n 'metric': 'temperature'\n },\n # json data: use a generated model or a json-serializable python data structure (dict, list)\n json = waylay.services.queries.QueryInput() # QueryInput | \n headers = {\n 'accept': 'accept_example',\n },\n )\n print(\"The response of queries.execute.execute:\\n\")\n pprint(api_response)\nexcept ApiError as e:\n print(\"Exception when calling queries.execute.execute: %s\\n\" % e)\n```\n\n\nFor more information, please visit the [Waylay API documentation](https://docs.waylay.io/#/api/?id=software-development-kits).\n",
"bugtrack_url": null,
"license": "ISC License (ISC) Copyright 2024, Waylay Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.",
"summary": "Waylay Query: timeseries queries (v1 protocol) Types",
"version": "0.5.0.20240809",
"project_urls": {
"Documentation": "https://docs.waylay.io/#/api/?id=software-development-kits",
"Homepage": "https://www.waylay.io/",
"Openapi Specification": "https://docs.waylay.io/openapi/public/redocly/queries.html",
"Repository": "https://github.com/waylayio/waylay-sdk-queries-py.git"
},
"split_keywords": [
"waylay query: timeseries queries (v1 protocol)",
" types"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce412bc93fdce476cf5911917435ae5729a6b2a8c8896ff808e39432729bd992",
"md5": "3a8067628a9466fe02ad87ef9137f169",
"sha256": "d9e8556f6584aec4c57aba74d0173f0bcb58531eb81295d0ef7a4b1962313533"
},
"downloads": -1,
"filename": "waylay_sdk_queries_types-0.5.0.20240809-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a8067628a9466fe02ad87ef9137f169",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 78612,
"upload_time": "2024-08-09T09:11:58",
"upload_time_iso_8601": "2024-08-09T09:11:58.157381Z",
"url": "https://files.pythonhosted.org/packages/ce/41/2bc93fdce476cf5911917435ae5729a6b2a8c8896ff808e39432729bd992/waylay_sdk_queries_types-0.5.0.20240809-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c2a40b93bb3d2820f58d9872899e85d53a80e9b0a54e7162751cbe80f6aa510",
"md5": "b620ea9d2f9cfbd0324787cb598662e3",
"sha256": "9101131df7b69b22f24be66fb1a7dee1293a86f066275c3a66315de898d1cdb1"
},
"downloads": -1,
"filename": "waylay_sdk_queries_types-0.5.0.20240809.tar.gz",
"has_sig": false,
"md5_digest": "b620ea9d2f9cfbd0324787cb598662e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 24085,
"upload_time": "2024-08-09T09:11:59",
"upload_time_iso_8601": "2024-08-09T09:11:59.136021Z",
"url": "https://files.pythonhosted.org/packages/8c/2a/40b93bb3d2820f58d9872899e85d53a80e9b0a54e7162751cbe80f6aa510/waylay_sdk_queries_types-0.5.0.20240809.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 09:11:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "waylayio",
"github_project": "waylay-sdk-queries-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "waylay-sdk-queries-types"
}
