Zeebe client api
Project description
Pyzeebe
pyzeebe is a python grpc client for Zeebe.
Zeebe version support:
Pyzeebe version | Tested Zeebe versions |
---|---|
2.x.x | 0.23, 0.24, 0.25 |
1.x.x | 0.23, 0.24 |
Getting Started
To install:
pip install pyzeebe
For full documentation please visit: https://pyzeebe.readthedocs.io/en/stable/
Usage
Worker
The ZeebeWorker
class uses threading to get and run jobs.
from pyzeebe import ZeebeWorker, Job
def on_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)
def example_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
Stop a worker:
zeebe_worker.work() # Worker will begin working
zeebe_worker.stop() # Stops worker after all running jobs have been completed
Client
from pyzeebe import ZeebeClient
# Create a zeebe client
zeebe_client = ZeebeClient(hostname="localhost", port=26500)
# Run a workflow
workflow_instance_key = zeebe_client.run_workflow(bpmn_process_id="My zeebe workflow", variables={})
# Run a workflow and receive the result
workflow_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 definition
zeebe_client.deploy_workflow("workflow.bpmn")
# Cancel a running workflow
zeebe_client.cancel_workflow_instance(workflow_instance_key=12345)
# Publish message
zeebe_client.publish_message(name="message_name", correlation_key="some_id")
Tests
Use the package manager pip to install pyzeebe
pytest tests/unit
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
We use the MIT license, see LICENSE.md for details
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
pyzeebe-2.2.3.tar.gz
(25.4 kB
view hashes)
Built Distribution
pyzeebe-2.2.3-py3-none-any.whl
(41.0 kB
view hashes)