Welcome to pyzeebe’s documentation!
Python client for Zeebe workflow engine
Current version is 4.1.0.
Library installation
$ pip install pyzeebe
Getting Started
Creating a worker
from pyzeebe import ZeebeWorker, create_insecure_channel
channel = create_insecure_channel()
worker = ZeebeWorker(channel)
@worker.task(task_type="my_task")
async def my_task(x: int):
return {"y": x + 1}
await worker.work()
Creating a client
from pyzeebe import ZeebeClient, create_insecure_channel
channel = create_insecure_channel()
client = ZeebeClient(channel)
await client.run_process("my_process")
# Run process with variables:
await client.run_process("my_process", variables={"x": 0})
Dependencies
python 3.7+
zeebe-grpc
grpcio
protobuf
oauthlib
requests-oauthlib
Table Of Contents
- Client
- Worker
- Channels
- Decorators
- Errors
PyZeebeError
TaskNotFoundError
NoVariableNameGivenError
DuplicateTaskTypeError
ActivateJobsRequestInvalidError
JobAlreadyDeactivatedError
JobNotFoundError
MessageAlreadyExistsError
ProcessDefinitionNotFoundError
ProcessInstanceNotFoundError
ProcessDefinitionHasNoStartEventError
ProcessTimeoutError
ProcessInvalidError
InvalidJSONError
ZeebeBackPressureError
ZeebeGatewayUnavailableError
ZeebeInternalError
ZeebeDeadlineExceeded
InvalidOAuthCredentialsError
UnknownGrpcStatusCodeError
- Exception Handler
- Zeebe Adapter