Python Pyrus API client
Project description
A python 3 client for the Pyrus API.
The full documentation for API can be found here.
Installation
- To get the latest version:
- pip (preffrered)
$ pip install –upgrade pyrus-api
- Setuptools: Use the easy_install tool included in the setuptools package:
$ easy_install –upgrade pyrus-api
- Manual installation: Download the latest version of pyrus-api client, unpack the code, and run
$ python setup.py install
Usage
To start with the module:
>>> from pyrus import client >>> import pyrus.models >>> pyrus_client = client.PyrusAPI(login='login@pyrus.com', security_key='sadf2R5Wrdkn..')
Examples
Authenticate:
>>> pyrus_client.auth()
Get all form templates:
>>> forms_response = pyrus_client.get_forms() >>> forms = forms_response.forms
Get list of tasks created using specified form:
>>> form_register_response = pyrus_client.get_registry(forms[0].id) >>> tasks = form_register_response.tasks
You can also filter registry by specific field value, status or current step number:
>>> request = pyrus.models.requests.FormRegisterRequest( include_archive=True, steps=[1,2], filters=[pyrus.models.entities.EqualsFilter(1, "hello world")]) >>> form_register_response = pyrus_client.get_registry(forms[0].id, request)
Get task with all comments:
>>> task = pyrus_client.get_task(tasks[0].id).task
Add new comment to the task:
>>> request = pyrus.models.requests.TaskCommentRequest(text="hello", action="finished") >>> task = pyrus_client.comment_task(tasks[0].id, request).task
- Upload a file:
>>> response = myclient.upload_file('C:\\path\\to\\file.txt').guid
Create a task:
>>> request = CreateTaskRequest( text="Task from python client", participants=['colleague@email.com', 10196] #you can specify person id, email, or pyrus.models.entities.Person object attachments = [guid]) >>> task = pyrus_client.create_task(request).task
Get all available contacts:
>>> contacts = pyrus_client.get_contacts()
Get catalog with all items:
>>> catalog_id = 1525 >>> catalog_response = pyrus_client.get_catalog(catalog_id) >>> items = catalog_response.items
Support
If you have any questions or comments please send an email to support@pyrus.com
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
pyrus-api-1.23.0.tar.gz
(18.0 kB
view hashes)
Built Distribution
pyrus_api-1.23.0-py3-none-any.whl
(21.1 kB
view hashes)
Close
Hashes for pyrus_api-1.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f23c317e408b8e4070598468ab62e111bfeb164ebb961b93e3dd0195ec72795a |
|
MD5 | 7e064f4bdb34b5a9a0f5411a5db82484 |
|
BLAKE2b-256 | 361dfaefc3157f21b797ac1e43998ca3d478611c55dd251031d146870f6fa772 |