# ZvolvClient SDK
<div>
📚 <a href="#documentation">Documentation</a> - 🚀 <a href="#getting-started">Getting started</a> - 💻 <a href="#api-reference">API reference</a> - 💬 <a href="#feedback">Feedback</a>
</div>
Learn how to automate with Zvolv using Python.
## Documentation
- [Docs site](https://python-zvolv-sdk.readthedocs.io/) - explore our docs site and learn more about Zvolv.
- [User Guide](https://github.com/zvolvapi/python-zvolv-sdk/blob/main/UserGuide.md) - explore our user guide docs and learn more about sdk.
## Getting started
### Installation
You can install the Zvolv Python SDK using the following command.
```
pip install zvolv-sdk
```
> Requires Python 3.0 or higher.
# Usage
## Initialize ZvolvClient
constructor(base_url: string)
Initializes the ZvolvClient with the base url of the Zvolv server.
Once the package is installed, you can import the library using import or require approach:
```bash
from zvolv_sdk import ZvolvClient
client = ZvolvClient('http://twig-me.com')
```
## Initialize Workspace
methods for interacting with workspaces.
```bash
try:
workspace = client.workspace.init('kapilwf')
except Error:
print(Error)
```
## Perform Authentication
methods for authentication.
```bash
try:
login = client.auth.login('email', 'pass')
except Error:
print(Error)
```
## Perform Analytics Search
methods for performing analytics-related operations.
```bash
try:
analytics = client.analytics.search('65c470f6dab3102c930725ca', { 'query': { 'match_all': {} }, 'from': 0, 'size': 20, 'track_total_hits': True)
except Error:
print(Error)
```
### Feedback
---
If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:
Use our [Github Issue Tracker][gh-issues] for reporting bugs or requesting features.
Visit the [Zvolv Community][zvolv-community] for getting help using Slack Developer Kit for Python or just generally bond with your fellow Zvolv developers.
<!-- Markdown links -->
[pypi-url]: https://pypi.org/project/slack-sdk/
[python-version]: https://img.shields.io/pypi/pyversions/slack-sdk.svg
[build-image]: https://github.com/slackapi/python-slack-sdk/workflows/CI%20Build/badge.svg
[build-url]: https://github.com/slackapi/python-slack-sdk/actions?query=workflow%3A%22CI+Build%22
[codecov-image]: https://codecov.io/gh/slackapi/python-slack-sdk/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/slackapi/python-slack-sdk
[contact-image]: https://img.shields.io/badge/contact-support-green.svg
[contact-url]: https://slack.com/support
[slackclientv1]: https://github.com/slackapi/python-slackclient/tree/v1
[api-methods]: https://api.slack.com/methods
[rtm-docs]: https://api.slack.com/rtm
[events-docs]: https://api.slack.com/events-api
[bolt-python]: https://github.com/slackapi/bolt-python
[pypi]: https://pypi.org/
[gh-issues]: https://github.com/zvolvapi/python-zvolv-sdk/issues
[zvolv-community]: https://zvolv.com/
[urllib]: https://docs.python.org/3/library/urllib.request.html
Raw data
{
"_id": null,
"home_page": "https://github.com/zvolvapi/python-zvolv-sdk",
"name": "zvolv-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": null,
"keywords": "zvolv, zvolv-api, web-api, sdk, rest-api-client",
"author": "Akshay Jadhav",
"author_email": "support@zvolv.com",
"download_url": "https://files.pythonhosted.org/packages/4c/30/2e4aba166501a6426c87f0e496011f216598a31f2a0fbc2e1c99768e875c/zvolv_sdk-0.0.10.tar.gz",
"platform": null,
"description": "# ZvolvClient SDK\n\n<div>\n\ud83d\udcda <a href=\"#documentation\">Documentation</a> - \ud83d\ude80 <a href=\"#getting-started\">Getting started</a> - \ud83d\udcbb <a href=\"#api-reference\">API reference</a> - \ud83d\udcac <a href=\"#feedback\">Feedback</a>\n</div>\n\n\nLearn how to automate with Zvolv using Python.\n## Documentation\n- [Docs site](https://python-zvolv-sdk.readthedocs.io/) - explore our docs site and learn more about Zvolv.\n- [User Guide](https://github.com/zvolvapi/python-zvolv-sdk/blob/main/UserGuide.md) - explore our user guide docs and learn more about sdk.\n\n## Getting started\n### Installation\nYou can install the Zvolv Python SDK using the following command.\n```\npip install zvolv-sdk\n```\n\n> Requires Python 3.0 or higher.\n\n# Usage\n## Initialize ZvolvClient\n\nconstructor(base_url: string)\n\nInitializes the ZvolvClient with the base url of the Zvolv server.\n\nOnce the package is installed, you can import the library using import or require approach:\n\n```bash\nfrom zvolv_sdk import ZvolvClient\n\nclient = ZvolvClient('http://twig-me.com')\n\n```\n\n## Initialize Workspace\n\nmethods for interacting with workspaces.\n\n```bash\n\ntry:\n workspace = client.workspace.init('kapilwf')\nexcept Error:\n print(Error)\n\n```\n## Perform Authentication\n\nmethods for authentication.\n\n```bash\ntry:\n login = client.auth.login('email', 'pass')\nexcept Error:\n print(Error)\n```\n## Perform Analytics Search\nmethods for performing analytics-related operations.\n\n```bash\ntry:\n analytics = client.analytics.search('65c470f6dab3102c930725ca', { 'query': { 'match_all': {} }, 'from': 0, 'size': 20, 'track_total_hits': True)\nexcept Error:\n print(Error)\n\n```\n\n### Feedback\n\n---\n\nIf you get stuck, we\u2019re here to help. The following are the best ways to get assistance working through your issue:\n\nUse our [Github Issue Tracker][gh-issues] for reporting bugs or requesting features.\nVisit the [Zvolv Community][zvolv-community] for getting help using Slack Developer Kit for Python or just generally bond with your fellow Zvolv developers.\n\n<!-- Markdown links -->\n\n\n[pypi-url]: https://pypi.org/project/slack-sdk/\n[python-version]: https://img.shields.io/pypi/pyversions/slack-sdk.svg\n[build-image]: https://github.com/slackapi/python-slack-sdk/workflows/CI%20Build/badge.svg\n[build-url]: https://github.com/slackapi/python-slack-sdk/actions?query=workflow%3A%22CI+Build%22\n[codecov-image]: https://codecov.io/gh/slackapi/python-slack-sdk/branch/main/graph/badge.svg\n[codecov-url]: https://codecov.io/gh/slackapi/python-slack-sdk\n[contact-image]: https://img.shields.io/badge/contact-support-green.svg\n[contact-url]: https://slack.com/support\n[slackclientv1]: https://github.com/slackapi/python-slackclient/tree/v1\n[api-methods]: https://api.slack.com/methods\n[rtm-docs]: https://api.slack.com/rtm\n[events-docs]: https://api.slack.com/events-api\n[bolt-python]: https://github.com/slackapi/bolt-python\n[pypi]: https://pypi.org/\n[gh-issues]: https://github.com/zvolvapi/python-zvolv-sdk/issues\n[zvolv-community]: https://zvolv.com/\n[urllib]: https://docs.python.org/3/library/urllib.request.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The Zvolv API Platform SDK for Python",
"version": "0.0.10",
"project_urls": {
"Download": "https://github.com/zvolvapi/python-zvolv-sdk/archive/v_01.tar.gz",
"Homepage": "https://github.com/zvolvapi/python-zvolv-sdk"
},
"split_keywords": [
"zvolv",
" zvolv-api",
" web-api",
" sdk",
" rest-api-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3759f1118ef1dfc0131c080b80a539b83694fbc0ef556444e52c7f12e9947c4",
"md5": "444fd3be3132789c4b77553c51754631",
"sha256": "5dd7d12a14e635b5561ed9a9ab8aa11840c39f863b74a36165347375b6391da7"
},
"downloads": -1,
"filename": "zvolv_sdk-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "444fd3be3132789c4b77553c51754631",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 7432,
"upload_time": "2024-04-29T19:43:33",
"upload_time_iso_8601": "2024-04-29T19:43:33.930581Z",
"url": "https://files.pythonhosted.org/packages/d3/75/9f1118ef1dfc0131c080b80a539b83694fbc0ef556444e52c7f12e9947c4/zvolv_sdk-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c302e4aba166501a6426c87f0e496011f216598a31f2a0fbc2e1c99768e875c",
"md5": "e4322a05fdcf304dd9eda21bf3e0d09d",
"sha256": "4814ad89f8f0e41a8d27fefac6af288e492b07b6d52306be2595c66477bfb155"
},
"downloads": -1,
"filename": "zvolv_sdk-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "e4322a05fdcf304dd9eda21bf3e0d09d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 7189,
"upload_time": "2024-04-29T19:43:34",
"upload_time_iso_8601": "2024-04-29T19:43:34.936237Z",
"url": "https://files.pythonhosted.org/packages/4c/30/2e4aba166501a6426c87f0e496011f216598a31f2a0fbc2e1c99768e875c/zvolv_sdk-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 19:43:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zvolvapi",
"github_project": "python-zvolv-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "zvolv-sdk"
}
JSON
