The Zvolv API Platform SDK for Python
Project description
ZvolvClient SDK
Learn how to automate with Zvolv using Python.
Documentation
- Docs site - explore our docs site and learn more about Zvolv.
- Examples - explore our examples docs and learn more about using 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
Once the package is installed, you can import the library using import or require approach.
Initializes the ZvolvClient with the base url of the Zvolv server:
from zvolv_sdk import ZvolvClient
client = ZvolvClient(BASE_URL)
BASE_URL is the host address on which your Zvolv workspace is deployed, unless you have isolated custom deployment use 'https://app.zvolv.com'.
Initialize Workspace
Before performing any operation, SDK needs your workspace context. Use below method to initialize your workspace
try:
workspace = client.workspace.init(DOMAIN)
except Error:
print(Error)
DOMAIN is your unique workspace identifier
Perform Authentication
Zvolv modules are access contolled, you need valid user crendentials to invoke any module methods. Use below method for authentication.
try:
login = client.auth.login(EMAIL, PASSWORD)
except Error:
print(Error)
You can use any valid zvolv user's EMAIL & PASSWORD from your workspace
API references
Zvolv comprises of various modules to achieve respective business operations. Use below modules & methods to interact with Zvolv APIs.
Forms
Create a Form
from zvolv_sdk.models.form import Form
form = Form(...)
response = client.forms.post(form)
Use Form model with required attributes
Update a Form
from zvolv_sdk.models.form import Form
form = Form(...)
response = client.forms.put(form)
Use Form model with id or uuid & other required attributes
Get a Form
from zvolv_sdk.models.form import Form
response: Form = client.forms.get(ID)
ID is unique form identifier
Submissions
Create a Submission
from zvolv_sdk.models.submission import Submission
submission = Submission(...)
response = client.submissions.post(submission)
Use Submission model with elements to be created
Update a Submission
from zvolv_sdk.models.submission import Submission
submission = Submission(...)
response = client.submissions.put(submission)
Use Submission model with id & elements to be updated
Get a Submission
from zvolv_sdk.models.submission import Submission
response: Submission = client.submissions.get(ID)
ID is unique submission identifier
Search Submissions
from elasticsearch_dsl import Q, Search
search_obj = Search()
bool_query = Q('bool', must=[Q(...)])
search_obj = search_obj.query(bool_query)
response = client.submissions.search(FORM_ID, search_obj)
search method support elastic queries. Generate your query with help of elasticsearch_dsl
Tasks
Create a Task
from zvolv_sdk.models.task import Task
task = Task(...)
response = client.tasks.post(task)
Use Task model with required attributes
Update a Task
from zvolv_sdk.models.task import Task
task = Task(...)
response = client.tasks.put(task)
Use Task model with id & required attributes to be updated
Get a Task
from zvolv_sdk.models.task import Task
response: Task = client.tasks.get(ID)
ID is unique task identifier
Search Tasks
from elasticsearch_dsl import Q, Search
search_obj = Search()
bool_query = Q('bool', must=[Q(...)])
search_obj = search_obj.query(bool_query)
response = client.tasks.search(search_obj)
search method support elastic queries. Generate your query with help of elasticsearch_dsl
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 Zvolv Developer Kit for Python or just generally bond with your fellow Zvolv developers.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for zvolv_sdk-0.0.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b5272d73de4ce81390ab5bdf6ac36ecb38781df44132daa83930c20ac07df65 |
|
MD5 | 223efb6ded96bcea1728f8f8dda340f7 |
|
BLAKE2b-256 | 497f3f2e04c663edc6393406eaa79f98ef9576707294adb2616e09ebb43d037d |