BeeYard-SDK: A client library for accessing Hive API
####################################################
Release notes
=============
Release notes are available on the documentation web page https://docs.beeyard.ai/docs/reference/sdk/python/release-notes/.
Installation
============
To use the package, just install it via pip (or preferred package manager):
.. code-block:: bash
pip install datavision-beeyard-sdk
or use Poetry package manager to create your virtual environment and just add the SDK with:
.. code-block:: bash
poetry add datavision-beeyard-sdk
Now all functionalities are ready to be imported inside your Python project!
Initialize a BeeYard client
===========================
Authentication is with authenticated client:
.. code-block:: python
from beeyard_sdk import AuthenticatedClient
client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password)
It is possible to specify the *max_waiting_time_ms* parameter (in milliseconds) when creating the client object in order to avoid connectivity problems.
It specifies the max time within which the client tries to repeatedly send the request, in case of connectivity errors. After that time,
a ConnectionError will be raised. Default value is 0.
.. code-block:: python
client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password, max_waiting_time_ms=1000)
As login endpoint will be updated, some optional parameters are provided, that can be set to point to the new endpoint:
.. code-block:: python
client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password, max_waiting_time_ms=1000, client_id="byard", client_secret="", login_url=None)
where *login_url* is the new endpoint uri.
It is possible to log in using client credentials as follows:
.. code-block:: python
client = AuthenticatedClient('https://demo.beeyard.ai/hive/', grant_type="client_credentials", client_id="the_client_id", client_secret="the_client_secret", login_url="https://demo.beeyard.ai/id/")
Another option is to use a valid access token to initialize the client:
.. code-block:: python
client = AuthenticatedClient('https://demo.beeyard.ai/hive/', use_token=True, token="valid_token")
Example usage
=============
.. code-block:: python
from datavision_beeyard_sdk.models import WorkspaceDescriptorDto
from datavision_beeyard_sdk.api.workspace import create_workspace
workspace_desc = WorkspaceDescriptorDto(name="test", namespace="test")
create_workspace.create(client=client, request_body=workspace_desc)
Documentation
=============
Complete documentation can be found at https://docs.beeyard.ai/docs/reference/sdk/python/methods_reference/.
Raw data
{
"_id": null,
"home_page": "https://docs.beeyard.ai/docs/reference/sdk/python/",
"name": "datavision-beeyard-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "python,sdk,beeyard",
"author": "DataVision",
"author_email": "support@datavision.software",
"download_url": "https://files.pythonhosted.org/packages/a0/08/05f5b93a334b26efd919399ed55da2c60a87d8b239a5f7dab27e584fab8c/datavision_beeyard_sdk-12.6.0.tar.gz",
"platform": null,
"description": "BeeYard-SDK: A client library for accessing Hive API\n####################################################\n\nRelease notes\n=============\n\nRelease notes are available on the documentation web page https://docs.beeyard.ai/docs/reference/sdk/python/release-notes/.\n\nInstallation\n============\nTo use the package, just install it via pip (or preferred package manager):\n\n.. code-block:: bash\n\n pip install datavision-beeyard-sdk\n\nor use Poetry package manager to create your virtual environment and just add the SDK with:\n\n.. code-block:: bash\n\n poetry add datavision-beeyard-sdk\n\nNow all functionalities are ready to be imported inside your Python project!\n\nInitialize a BeeYard client\n===========================\nAuthentication is with authenticated client:\n\n.. code-block:: python\n\n from beeyard_sdk import AuthenticatedClient\n client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password)\n\nIt is possible to specify the *max_waiting_time_ms* parameter (in milliseconds) when creating the client object in order to avoid connectivity problems.\nIt specifies the max time within which the client tries to repeatedly send the request, in case of connectivity errors. After that time,\na ConnectionError will be raised. Default value is 0.\n\n.. code-block:: python\n\n client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password, max_waiting_time_ms=1000)\n\nAs login endpoint will be updated, some optional parameters are provided, that can be set to point to the new endpoint:\n\n.. code-block:: python\n\n client = AuthenticatedClient('https://demo.beeyard.ai/hive/', username, password, max_waiting_time_ms=1000, client_id=\"byard\", client_secret=\"\", login_url=None)\n\nwhere *login_url* is the new endpoint uri.\n\nIt is possible to log in using client credentials as follows:\n\n.. code-block:: python\n\n client = AuthenticatedClient('https://demo.beeyard.ai/hive/', grant_type=\"client_credentials\", client_id=\"the_client_id\", client_secret=\"the_client_secret\", login_url=\"https://demo.beeyard.ai/id/\")\n\nAnother option is to use a valid access token to initialize the client:\n\n.. code-block:: python\n\n client = AuthenticatedClient('https://demo.beeyard.ai/hive/', use_token=True, token=\"valid_token\")\n\nExample usage\n=============\n\n.. code-block:: python\n\n from datavision_beeyard_sdk.models import WorkspaceDescriptorDto\n from datavision_beeyard_sdk.api.workspace import create_workspace\n\n workspace_desc = WorkspaceDescriptorDto(name=\"test\", namespace=\"test\")\n create_workspace.create(client=client, request_body=workspace_desc)\n\nDocumentation\n=============\n\nComplete documentation can be found at https://docs.beeyard.ai/docs/reference/sdk/python/methods_reference/.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BeeYard Python SDK",
"version": "12.6.0",
"project_urls": {
"Homepage": "https://docs.beeyard.ai/docs/reference/sdk/python/"
},
"split_keywords": [
"python",
"sdk",
"beeyard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d98e6097afa98003412d8b1d67b386c2c38026dc63b245d463928290dcb3a010",
"md5": "3c3bced54b867c65a9b6c6832f6c25d1",
"sha256": "040a04342d665bc4cd8cf4a357ddb847f563488a13a7bd27a9e6fbea02a41a9f"
},
"downloads": -1,
"filename": "datavision_beeyard_sdk-12.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c3bced54b867c65a9b6c6832f6c25d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 65482,
"upload_time": "2023-12-11T11:56:19",
"upload_time_iso_8601": "2023-12-11T11:56:19.187505Z",
"url": "https://files.pythonhosted.org/packages/d9/8e/6097afa98003412d8b1d67b386c2c38026dc63b245d463928290dcb3a010/datavision_beeyard_sdk-12.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a00805f5b93a334b26efd919399ed55da2c60a87d8b239a5f7dab27e584fab8c",
"md5": "3a517d4ef3ccc4eaab8d265008616354",
"sha256": "2831a1cfd92ecd6a78971b2f28ff8f02cb1e965795086e4d1f62dfe261461f80"
},
"downloads": -1,
"filename": "datavision_beeyard_sdk-12.6.0.tar.gz",
"has_sig": false,
"md5_digest": "3a517d4ef3ccc4eaab8d265008616354",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 22323,
"upload_time": "2023-12-11T11:56:21",
"upload_time_iso_8601": "2023-12-11T11:56:21.104001Z",
"url": "https://files.pythonhosted.org/packages/a0/08/05f5b93a334b26efd919399ed55da2c60a87d8b239a5f7dab27e584fab8c/datavision_beeyard_sdk-12.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-11 11:56:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "datavision-beeyard-sdk"
}
JSON