| Name | onvo JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Communicate with the Onvo platform. |
| upload_time | 2024-04-02 13:22:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
python
onvo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Onvo
The Onvo package provides utilities to seamlessly communicate with the Onvo platform, allowing developers to integrate AI-powered dashboards into their products. This README provides an overview of the package's features, installation, and usage instructions.
## Installation
You can install the package using pip:
```bash
pip install onvo
```
## Getting Started
To begin using the Onvo package, you'll need an API key from the Onvo platform and an endpoint.
You can store your API key as an environment variable named `ONVO_API_KEY`.
```bash
ONVO_API_KEY="your_api_key"
```
You can store the endpoint as an environment variable named `ONVO_API_ENDPOINT`.
```bash
ONVO_API_ENDPOINT="https://dashboard.onvo.ai/api"
```
## Usage
Here's an example of how to use the package to interact with the Onvo platform:
```python
from onvo import Onvo
# Initialize the Onvo class with your API key, will default to ENV variables if not given.
onvoSDK = Onvo(endpoint="https://dashboard.onvo.ai/api", api_key="your_api_key_here")
# Identify/Create a user
const sample_user_id = onvoSDK.embed_users.upsert({
"id": 'sample-embed-user-id',
"name": "John Appleseed",
"email": "john@appleseed.com",
"metadata": {
"phone_number": "+1 234 5678",
"organisation_id": "87dfty9872ydq8tg",
},
})["id"]
# Create a dashboard
const sample_dashboard_id = onvoSDK.dashboards.create({
"title": "Sample Dashboard",
"description": "Sample Description of a Sample Dashboard."
})["id"]
# Create a session
sessionUrl = onvoSDK.sessions.upsert(
sample_dashboard_id,
sample_user_id
)["url"]
```
## Library Reference
Feel free to use the `help()` method on any of the functions to dig deeper.
### Global Variables
- `.api_key`: Your API key for authentication.
- `.endpoint`: The base URL to the Onvo platform or your self-hosted endpoint.
### Accounts
- `.accounts.list()`
- `.accounts.get(id:str)`
### Automations
- `.automations.list()`
- `.automations.get(id:str)`
- `.automations.create(data:dict)`
- `.automations.update(id:str, data:dict)`
- `.automations.delete(id:str)`
- `.automations.get_runs(id:str)`
### Dashboards
- `.dashboards.list()`
- `.dashboards.get(id:str)`
- `.dashboards.create(data:dict)`
- `.dashboards.update(id:str, data:dict)`
- `.dashboards.delete(id:str)`
- `.dashboards.update_cache(id:str)`
- `.dashboard(dashboard_id:str).datasources.list()`
- `.dashboard(dashboard_id:str).datasources.link(datasource_id:str)`
- `.dashboard(dashboard_id:str).datasources.unlink(datasource_id:str)`
### Datasources
- `.datasources.list()`
- `.datasources.get(id:str)`
- `.datasources.create(data:dict)`
- `.datasources.update(id:str, data:dict)`
- `.datasources.delete(id:str)`
- `.datasources.initialize(id:str)`
- `.datasources.upload_file(id:str)`
### Embed Users
- `.embed_users.list()`
- `.embed_users.get(id:str)`
- `.embed_users.upsert(id:str, data:dict)`
- `.embed_users.delete(id:str)`
- `.embed_users.get_access_token(id:str)`
### Sessions
- `.sessions.list(dashboard_id:str)`
- `.sessions.upsert(dashboard_id:str, user_id:dict)`
- `.sessions.delete(dashboard_id:str)`
### Teams
- `.teams.list()`
- `.teams.get(id:str)`
- `.teams.update(id:str)`
### Questions
- `.questions.list(dashboard_id:str)`
- `.questions.create(dashboard_id:str, query:str)`
- `.questions.delete(question_id:str)`
- `.questions.update(question_id:str, data:dict)`
### Widgets
- `.widgets.list(dashboard_id:str)`
- `.widgets.get(id:str)`
- `.widgets.create(dashboard_id:str, query:str)`
- `.widgets.update(id:str, data:dict)`
- `.widgets.delete(id:str)`
- `.widgets.export(id:str, format:str)`
- `.widgets.request_edit(id:str, data:dict)`
- `.widgets.execute_code(id:str, code:str)`
## Support
For any issues, questions, or feedback, please contact our support team at info@onvo.ai.
## License
This package is distributed under the MIT License.
Thank you for choosing the Onvo package to integrate AI-powered dashboards from the Onvo platform into your product! We hope this package enhances your development experience and empowers your applications with advanced analytics capabilities.
Raw data
{
"_id": null,
"home_page": null,
"name": "onvo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, onvo",
"author": null,
"author_email": "Bryan Davis <bryandavis999.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ad/72/f612d1196a4fb6dc7687c563d4e8238d2ad095a532b0a4689859ee4dca87/onvo-0.2.0.tar.gz",
"platform": null,
"description": "# Onvo\n\nThe Onvo package provides utilities to seamlessly communicate with the Onvo platform, allowing developers to integrate AI-powered dashboards into their products. This README provides an overview of the package's features, installation, and usage instructions.\n\n## Installation\n\nYou can install the package using pip:\n\n```bash\npip install onvo\n```\n\n## Getting Started\n\nTo begin using the Onvo package, you'll need an API key from the Onvo platform and an endpoint.\n\nYou can store your API key as an environment variable named `ONVO_API_KEY`.\n\n```bash\nONVO_API_KEY=\"your_api_key\"\n```\n\nYou can store the endpoint as an environment variable named `ONVO_API_ENDPOINT`.\n\n```bash\nONVO_API_ENDPOINT=\"https://dashboard.onvo.ai/api\"\n```\n\n## Usage\n\nHere's an example of how to use the package to interact with the Onvo platform:\n\n```python\nfrom onvo import Onvo\n\n# Initialize the Onvo class with your API key, will default to ENV variables if not given.\nonvoSDK = Onvo(endpoint=\"https://dashboard.onvo.ai/api\", api_key=\"your_api_key_here\")\n\n# Identify/Create a user\nconst sample_user_id = onvoSDK.embed_users.upsert({\n \"id\": 'sample-embed-user-id',\n \"name\": \"John Appleseed\",\n \"email\": \"john@appleseed.com\",\n \"metadata\": {\n \"phone_number\": \"+1 234 5678\",\n \"organisation_id\": \"87dfty9872ydq8tg\",\n },\n})[\"id\"]\n\n# Create a dashboard\nconst sample_dashboard_id = onvoSDK.dashboards.create({\n \"title\": \"Sample Dashboard\",\n \"description\": \"Sample Description of a Sample Dashboard.\"\n})[\"id\"]\n\n# Create a session\nsessionUrl = onvoSDK.sessions.upsert(\n sample_dashboard_id,\n sample_user_id\n)[\"url\"]\n```\n\n## Library Reference\n\nFeel free to use the `help()` method on any of the functions to dig deeper.\n\n### Global Variables\n- `.api_key`: Your API key for authentication.\n- `.endpoint`: The base URL to the Onvo platform or your self-hosted endpoint.\n\n### Accounts\n- `.accounts.list()`\n- `.accounts.get(id:str)`\n\n### Automations\n- `.automations.list()`\n- `.automations.get(id:str)`\n- `.automations.create(data:dict)`\n- `.automations.update(id:str, data:dict)`\n- `.automations.delete(id:str)`\n\n- `.automations.get_runs(id:str)`\n\n### Dashboards\n- `.dashboards.list()`\n- `.dashboards.get(id:str)`\n- `.dashboards.create(data:dict)`\n- `.dashboards.update(id:str, data:dict)`\n- `.dashboards.delete(id:str)`\n\n- `.dashboards.update_cache(id:str)`\n\n- `.dashboard(dashboard_id:str).datasources.list()`\n- `.dashboard(dashboard_id:str).datasources.link(datasource_id:str)`\n- `.dashboard(dashboard_id:str).datasources.unlink(datasource_id:str)`\n\n### Datasources\n- `.datasources.list()`\n- `.datasources.get(id:str)`\n- `.datasources.create(data:dict)`\n- `.datasources.update(id:str, data:dict)`\n- `.datasources.delete(id:str)`\n\n- `.datasources.initialize(id:str)`\n- `.datasources.upload_file(id:str)`\n\n### Embed Users\n- `.embed_users.list()`\n- `.embed_users.get(id:str)`\n- `.embed_users.upsert(id:str, data:dict)`\n- `.embed_users.delete(id:str)`\n\n- `.embed_users.get_access_token(id:str)`\n\n### Sessions\n- `.sessions.list(dashboard_id:str)`\n- `.sessions.upsert(dashboard_id:str, user_id:dict)`\n- `.sessions.delete(dashboard_id:str)`\n\n### Teams\n- `.teams.list()`\n- `.teams.get(id:str)`\n- `.teams.update(id:str)`\n\n### Questions\n- `.questions.list(dashboard_id:str)`\n- `.questions.create(dashboard_id:str, query:str)`\n- `.questions.delete(question_id:str)`\n- `.questions.update(question_id:str, data:dict)`\n\n### Widgets\n- `.widgets.list(dashboard_id:str)`\n- `.widgets.get(id:str)`\n- `.widgets.create(dashboard_id:str, query:str)`\n- `.widgets.update(id:str, data:dict)`\n- `.widgets.delete(id:str)`\n\n- `.widgets.export(id:str, format:str)`\n- `.widgets.request_edit(id:str, data:dict)`\n- `.widgets.execute_code(id:str, code:str)`\n\n## Support\n\nFor any issues, questions, or feedback, please contact our support team at info@onvo.ai.\n\n## License\n\nThis package is distributed under the MIT License.\n\nThank you for choosing the Onvo package to integrate AI-powered dashboards from the Onvo platform into your product! We hope this package enhances your development experience and empowers your applications with advanced analytics capabilities.\n",
"bugtrack_url": null,
"license": null,
"summary": "Communicate with the Onvo platform.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/onvo-ai/sdks",
"Issues": "https://github.com/onvo-ai/sdks/issues"
},
"split_keywords": [
"python",
" onvo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "231e2659ca68ac3fe0d4d4d7c7086abaa3b1912b3fc0617e019ee0f1df553b44",
"md5": "d122bdb323be5513f77e085aa3a2165b",
"sha256": "97f67c43a73033eff8dfca650e7de3f03102cd597b0ba01d54f93ed0e4c4c706"
},
"downloads": -1,
"filename": "onvo-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d122bdb323be5513f77e085aa3a2165b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14286,
"upload_time": "2024-04-02T13:22:51",
"upload_time_iso_8601": "2024-04-02T13:22:51.935189Z",
"url": "https://files.pythonhosted.org/packages/23/1e/2659ca68ac3fe0d4d4d7c7086abaa3b1912b3fc0617e019ee0f1df553b44/onvo-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad72f612d1196a4fb6dc7687c563d4e8238d2ad095a532b0a4689859ee4dca87",
"md5": "48b8af3b8308ba9ca52818340d397e24",
"sha256": "64c35ec50b801a1797d516f0f9b2b25f87e7422f1dce364afe5ad4c2b36c34d8"
},
"downloads": -1,
"filename": "onvo-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "48b8af3b8308ba9ca52818340d397e24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12241,
"upload_time": "2024-04-02T13:22:55",
"upload_time_iso_8601": "2024-04-02T13:22:55.204477Z",
"url": "https://files.pythonhosted.org/packages/ad/72/f612d1196a4fb6dc7687c563d4e8238d2ad095a532b0a4689859ee4dca87/onvo-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 13:22:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "onvo-ai",
"github_project": "sdks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "onvo"
}
