| Name | waylay-sdk-core JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | Waylay Python SDK. |
| upload_time | 2024-12-11 13:33:34 |
| 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
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Waylay Python SDK
Python SDK for the Waylay Platform.
This `waylay-sdk-core` package provides a basic SDK client for the [Waylay REST apis](https://docs.waylay.io/#/api/?id=openapi-docs).
See [Waylay Docs](https://docs.waylay.io/#/api/sdk/python) for documentation.
## Installation
This package requires a python runtime `3.9` or higher.
The basic client can be installed with
```bash
pip install waylay-sdk-core
```
This client provides configuration, authorization and plugin features for the SDK.
It includes a generic http client to make authenticated calls to the services available on your _Waylay_ gateway endpoint.
Support for specific Waylay services or tools is provided by separate extension packages.
See [`waylay-sdk`](https://pypi.org/project/waylay-sdk) to install a client that includes the recommended extensions.
## Basic usage
### Interactive Authentication
When used outside the Waylay platform (e.g. in a _python notebook_) the client requires you to provide
* the gateway endpoint: `api.waylay.io` for Enterprise users,
* an API key-secret pair: see [Waylay Console](console.waylay.io) at _>Settings>Authentication keys_.
```python
from waylay.sdk import WaylayClient
# this will interactively request the gateway and credentials on first usage.
client = WaylayClient.from_profile()
# list the available service packages
client.services
# use the generic api client to see the status page of the 'registry' service.
resp = await client.api_client.request('GET', '/registry/v2')
```
Credentials and endpoints are stored in a local _profile_ file (you can have multiple such profiles).
Other authentication methods are available (JWToken, pass apiKey/Secret directly)
Raw data
{
"_id": null,
"home_page": null,
"name": "waylay-sdk-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "waylay, sdk",
"author": null,
"author_email": "Waylay <info@waylay.io>",
"download_url": "https://files.pythonhosted.org/packages/23/6d/4fb25277c9f321c14272156b50505fdcbd32964a26b661dfcea1273c137d/waylay_sdk_core-0.3.2.tar.gz",
"platform": null,
"description": "# Waylay Python SDK\n\nPython SDK for the Waylay Platform.\n\nThis `waylay-sdk-core` package provides a basic SDK client for the [Waylay REST apis](https://docs.waylay.io/#/api/?id=openapi-docs). \n\nSee [Waylay Docs](https://docs.waylay.io/#/api/sdk/python) for documentation.\n\n## Installation\n\nThis package requires a python runtime `3.9` or higher.\n\nThe basic client can be installed with\n```bash\npip install waylay-sdk-core\n```\n\nThis client provides configuration, authorization and plugin features for the SDK.\n\nIt includes a generic http client to make authenticated calls to the services available on your _Waylay_ gateway endpoint.\n\nSupport for specific Waylay services or tools is provided by separate extension packages.\n\nSee [`waylay-sdk`](https://pypi.org/project/waylay-sdk) to install a client that includes the recommended extensions.\n\n## Basic usage\n\n### Interactive Authentication\n\nWhen used outside the Waylay platform (e.g. in a _python notebook_) the client requires you to provide\n* the gateway endpoint: `api.waylay.io` for Enterprise users,\n* an API key-secret pair: see [Waylay Console](console.waylay.io) at _>Settings>Authentication keys_.\n\n```python\nfrom waylay.sdk import WaylayClient\n\n# this will interactively request the gateway and credentials on first usage.\nclient = WaylayClient.from_profile()\n\n# list the available service packages\nclient.services\n\n# use the generic api client to see the status page of the 'registry' service.\nresp = await client.api_client.request('GET', '/registry/v2')\n```\n\nCredentials and endpoints are stored in a local _profile_ file (you can have multiple such profiles).\nOther authentication methods are available (JWToken, pass apiKey/Secret directly)\n\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 Python SDK.",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://docs.waylay.io/#/",
"Homepage": "https://www.waylay.io/",
"Repository": "https://github.com/waylayio/waylay-sdk-py.git"
},
"split_keywords": [
"waylay",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ba56a52e2306a84d4622a2438a380c2740606b7900e9e0da931b26a769a7a03",
"md5": "589091b3a226b7bacb6fe3faca02ab9a",
"sha256": "7440a04e7fdec20f885c7d4ed9957d7c20c363a658921d31dbbba966fa53ca79"
},
"downloads": -1,
"filename": "waylay_sdk_core-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "589091b3a226b7bacb6fe3faca02ab9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 35931,
"upload_time": "2024-12-11T13:33:31",
"upload_time_iso_8601": "2024-12-11T13:33:31.580389Z",
"url": "https://files.pythonhosted.org/packages/0b/a5/6a52e2306a84d4622a2438a380c2740606b7900e9e0da931b26a769a7a03/waylay_sdk_core-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "236d4fb25277c9f321c14272156b50505fdcbd32964a26b661dfcea1273c137d",
"md5": "9a33fdbec8358f56082bf53cb4388811",
"sha256": "7f609f5e2368dd439aa624c94f1fd0eadc98422c5024f749f293492620c6886f"
},
"downloads": -1,
"filename": "waylay_sdk_core-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "9a33fdbec8358f56082bf53cb4388811",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 29228,
"upload_time": "2024-12-11T13:33:34",
"upload_time_iso_8601": "2024-12-11T13:33:34.160498Z",
"url": "https://files.pythonhosted.org/packages/23/6d/4fb25277c9f321c14272156b50505fdcbd32964a26b661dfcea1273c137d/waylay_sdk_core-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 13:33:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "waylayio",
"github_project": "waylay-sdk-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "waylay-sdk-core"
}
