zvolv-sdk 0.0.10

The Zvolv API Platform SDK for Python

ZvolvClient SDK

📚 Documentation - 🚀 Getting started - 💻 API reference - 💬 Feedback

Learn how to automate with Zvolv using Python.

Documentation

• Docs site - explore our docs site and learn more about Zvolv.
• User Guide - 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:

from zvolv_sdk import ZvolvClient

client = ZvolvClient('http://twig-me.com')

Initialize Workspace

methods for interacting with workspaces.

try:
    workspace = client.workspace.init('kapilwf')
except Error:
    print(Error)

Perform Authentication

methods for authentication.

try:
    login = client.auth.login('email', 'pass')
except Error:
    print(Error)

Perform Analytics Search

methods for performing analytics-related operations.

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 for reporting bugs or requesting features. Visit the Zvolv Community for getting help using Slack Developer Kit for Python or just generally bond with your fellow Zvolv developers.