python pyrus api客户端
pyrus-api的Python项目详细描述
Pyrus API的Python3客户端。
api的完整文档可以在here中找到。
安装
- 获取最新版本:
- pip(预飞)
- $pip安装–升级pyrus api
- Setuptools:使用setuptools包中包含的简易安装工具:
- $easy_install–升级pyrus api
- 手动安装:Download the latest version of pyrus-api client,解压缩代码,然后运行
- $python setup.py安装
用法
从模块开始:
>>> from pyrus import client >>> import pyrus.models >>> pyrus_client = client.PyrusAPI(login='login@pyrus.com', security_key='sadf2R5Wrdkn..')
示例
验证:
>>> pyrus_client.auth()
获取所有表单模板:
>>> forms_response = pyrus_client.get_forms() >>> forms = forms_response.forms
获取使用指定表单创建的任务列表:
>>> form_register_response = pyrus_client.get_registry(forms[0].id) >>> tasks = form_register_response.tasks
您还可以按特定字段值、状态或当前步骤号筛选注册表:
>>> 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)
获取包含所有评论的任务:
>>> task = pyrus_client.get_task(tasks[0].id).task
向任务添加新注释:
>>> request = pyrus.models.requests.TaskCommentRequest(text="hello", action="finished") >>> task = pyrus_client.comment_task(tasks[0].id, request).task
- 上载文件:
>>> response = myclient.upload_file('C:\\path\\to\\file.txt').guid
创建任务:
>>> 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
获取所有可用联系人:
>>> contacts = pyrus_client.get_contacts()
获取包含所有项目的目录:
>>> catalog_id = 1525 >>> catalog_response = pyrus_client.get_catalog(catalog_id) >>> items = catalog_response.items
支架
如果您有任何问题或意见,请发送电子邮件至support@pyrus.com