v2.1.0

Added:

• Full task api to @worker.task decorator:
  • variables_to_fetch param - which variables to fetch from the workflow instance scope
  • timeout param - how long until zeebe gives up on job
  • max_jobs_to_activate param - max jobs the worker can perform simultaneously (per task)
• Automatic variables_to_fetch. (from function.__code__.co_varnames)
• Base exception class named: PyZeebeException from which all custom exceptions inherit

Fixed:

• JobStatus not exported - #43
• Exceptions not exported - #44

v2.0.1

Fixed:

• TaskDecorator and ZeebeTaskRouter not being in exports

v2.0.0

v2.2.0

Using decorators instead of classes to create tasks

Changes

• Added ability to create task using decorator: @worker.task()
• Added class called ZeebeTaskRouter which should help organize projects
• Renamed TaskContext to Job
• Merged TaskStatusController functionality into the new Job class
• Removed Task from standard imports because of decorator

API Changes

External updates:

• Renamed TaskContext to Job
• Merged TaskStatusController functionality into the new Job class
• Renamed TaskStatus to JobStatus
• Moved stop_event from work internally, so users don't have to import threading.Event
• Added stop function to ZeebeWorker which now uses the internal threading.Event
• Renamed add_task to _add_task
• Added class ZeebeTaskRouter which inherits from ZeebeTaskHandler. This class allows splitting tasks into multiple files (like fastapi's APIRouter)
• Added include_router to ZeebeWorker which allows a ZeebeWorker instance to absorb a ZeebeTaskRouter's tasks
• Added ExceptionHandler for ease of use
• Added optional message_id parameter to publish_message in ZeebeClient

v1.2.3

Fixed:

• Job completed even when the task failed - #35

v1.2.2

Enhancements:

• Moved test files to tests
  • No test files in published package
  • Coverage more accurate

v1.2.1

Fixed:

• Tasks failing because of decorators

v1.2.0

Added:

• Secure connection options:
  • TLS
  • OAuth2
  • Camunda Cloud

Fixed

• Worker not working without stop event

v1.1.2

Fixed

• Test files being published to pypi - #20

v1.1.1

Fixed

• Dependencies not installed when installing pyzeebe - #19
• Test files being published to pypi - #20

v1.1.0

Added:

• Client functionality:
  • Run workflow
  • Run workflow with result (await workflow result)
  • Cancel running workflow instances
  • Deploy workflow definition file (bpmn/yaml)
  • Publish messages
• Self defined grpc exceptions
• Integration tests against zeebe