Zeebe客户端api
pyzeebe的Python项目详细描述
皮泽比
pyzeebe是Zeebe的python grpc客户端。在
Zeebe版本支持:
Pyzeebe version | Tested Zeebe versions |
---|---|
2.x.x | 0.23, 0.24 |
1.x.x | 0.23, 0.24 |
入门
要安装:
pip install pyzeebe
有关完整文档,请访问:https://pyzeebe.readthedocs.io/en/stable/
使用
工人
ZeebeWorker
类使用线程来获取和运行作业。在
frompyzeebeimportZeebeWorker,Jobdefon_error(exception:Exception,job:Job):""" on_error will be called when the task fails """print(exception)job.set_error_status(f"Failed to handle job {job}. Error: {str(exception)}")worker=ZeebeWorker(hostname="<zeebe_host>",port=26500)# Create a zeebe worker@worker.task(task_type="example",exception_handler=on_error)defexample_task(input:str):return{"output":f"Hello world, {input}!"}worker.work()# Now every time that a task with type example is called example_task will be called
阻止工人:
^{pr2}$客户
frompyzeebeimportZeebeClient# Create a zeebe clientzeebe_client=ZeebeClient(hostname="localhost",port=26500)# Run a workflowworkflow_instance_key=zeebe_client.run_workflow(bpmn_process_id="My zeebe workflow",variables={})# Run a workflow and receive the resultworkflow_result=zeebe_client.run_workflow_with_result(bpmn_process_id="My zeebe workflow",timeout=10000)# Will wait 10000 milliseconds (10 seconds)# Deploy a bpmn workflow definitionzeebe_client.deploy_workflow("workflow.bpmn")# Cancel a running workflowzeebe_client.cancel_workflow_instance(workflow_instance_key=12345)# Publish messagezeebe_client.publish_message(name="message_name",correlation_key="some_id")
测试
使用包管理器pip安装pyzeebe
pytest tests/unit
贡献
欢迎拉取请求。对于重大变化,请先打开一个问题,讨论您希望更改的内容。在
请确保根据需要更新测试。在
版本控制
我们使用SemVer进行版本控制。有关可用版本,请参阅此存储库上的标记。在
许可证
我们使用MIT许可证,详情请参见LICENSE.md
- 项目
标签: