| Name | waylay-sdk-rules JSON |
| Version |
6.5.0.20240802
JSON |
| download |
| home_page | None |
| Summary | Waylay rules engine |
| upload_time | 2024-08-02 13:40:33 |
| 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
rules
engine
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Waylay Rules Service
The REST api to manage rule tasks and rule templates in the Waylay platform.
This Python package is automatically generated based on the
Waylay Rules OpenAPI specification (API version: 6.5.0)
For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/rules.html).
It consists of a plugin for the waylay-sdk-core package, and contains the Rules api methods.
Note that the typed model classes for all path params, query params, body params and responses for each of the api methods are contained in a separate package called waylay-sdk-rules-types.
## 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-rules` together with the SDK api packages for other services.
* `pip install waylay-sdk[types-rules]` will additionally install the types package `waylay-sdk-rules-types`.
* `pip install waylay-sdk[types]` will install the types packages for this and all other services.
Alternatively, you can install support for this _rules_ service only, installing or extending an existing [waylay-sdk-core](https://pypi.org/project/waylay-sdk-core/):
- `pip install waylay-sdk-rules` to only install api support for _rules_.
- `pip install waylay-sdk-rules[types]` to additionally install type support for _rules_.
## 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-rules-types` is installed
from waylay.services.rules.models.version_response import VersionResponse
try:
# Get Service Information
# calls `GET /rules/v1`
api_response = await waylay_client.rules.about.get(
)
print("The response of rules.about.get:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling rules.about.get: %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-rules",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Waylay rules engine",
"author": null,
"author_email": "Waylay <info@waylay.io>",
"download_url": "https://files.pythonhosted.org/packages/a4/c7/22e596d425dcac381645cbd95e025e7b0ca99f8f0465164b7d76244a3663/waylay_sdk_rules-6.5.0.20240802.tar.gz",
"platform": null,
"description": "# Waylay Rules Service\nThe REST api to manage rule tasks and rule templates in the Waylay platform.\n\nThis Python package is automatically generated based on the \nWaylay Rules OpenAPI specification (API version: 6.5.0)\nFor more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/rules.html).\n\nIt consists of a plugin for the waylay-sdk-core package, and contains the Rules api methods.\nNote that the typed model classes for all path params, query params, body params and responses for each of the api methods are contained in a separate package called waylay-sdk-rules-types.\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-rules` together with the SDK api packages for other services.\n* `pip install waylay-sdk[types-rules]` will additionally install the types package `waylay-sdk-rules-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 _rules_ service only, installing or extending an existing [waylay-sdk-core](https://pypi.org/project/waylay-sdk-core/):\n\n- `pip install waylay-sdk-rules` to only install api support for _rules_.\n- `pip install waylay-sdk-rules[types]` to additionally install type support for _rules_.\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-rules-types` is installed\nfrom waylay.services.rules.models.version_response import VersionResponse\ntry:\n # Get Service Information\n # calls `GET /rules/v1`\n api_response = await waylay_client.rules.about.get(\n )\n print(\"The response of rules.about.get:\\n\")\n pprint(api_response)\nexcept ApiError as e:\n print(\"Exception when calling rules.about.get: %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 rules engine",
"version": "6.5.0.20240802",
"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/rules.html",
"Repository": "https://github.com/waylayio/waylay-sdk-rules-py.git"
},
"split_keywords": [
"waylay",
"rules",
"engine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb009c4b5c0be2b3fb2c618c61fcd2499937775d4c656e55fc986380cfd7a5d2",
"md5": "7e47302807ed4a005fc4a8bf5c713bcd",
"sha256": "4248d48ca1ea78cb1fd6dd4fa68850879b78559ac31495ce629fd0d793f5e267"
},
"downloads": -1,
"filename": "waylay_sdk_rules-6.5.0.20240802-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e47302807ed4a005fc4a8bf5c713bcd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 28894,
"upload_time": "2024-08-02T13:40:32",
"upload_time_iso_8601": "2024-08-02T13:40:32.549396Z",
"url": "https://files.pythonhosted.org/packages/fb/00/9c4b5c0be2b3fb2c618c61fcd2499937775d4c656e55fc986380cfd7a5d2/waylay_sdk_rules-6.5.0.20240802-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4c722e596d425dcac381645cbd95e025e7b0ca99f8f0465164b7d76244a3663",
"md5": "966971d9c98b6a90b2d69cab1ba5f0ba",
"sha256": "ef1ec014bed2db21ae4a57910afb2061d6d7cb96cfcac6c8afc813552873d2a0"
},
"downloads": -1,
"filename": "waylay_sdk_rules-6.5.0.20240802.tar.gz",
"has_sig": false,
"md5_digest": "966971d9c98b6a90b2d69cab1ba5f0ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17275,
"upload_time": "2024-08-02T13:40:33",
"upload_time_iso_8601": "2024-08-02T13:40:33.573946Z",
"url": "https://files.pythonhosted.org/packages/a4/c7/22e596d425dcac381645cbd95e025e7b0ca99f8f0465164b7d76244a3663/waylay_sdk_rules-6.5.0.20240802.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 13:40:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "waylayio",
"github_project": "waylay-sdk-rules-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "waylay-sdk-rules"
}
