Pyzeebe 3.0.0

[JonatanMartens]

Zeebe 1.0.0 is currently in alpha. This release will contain some breaking changes (see here). I believe this to be an opportunity to make some other breaking changes:

• Rename workflow to process (like in Zeebe 1.0.0)
• Asyncio support
• Further refactoring of the ZeebeWorker class (Refactor/task builder #131 is the start)
• Return the workflow instance key alongside variables when calling run_workflow_with_result - see return response.variables and workflowInstanceKey #105
• Limit numbers of running jobs - see Limit number of running jobs #103

Please feel free to add any suggestions for other potential changes here!

[kbakk]

This sounds like it will introduce a few breaking changes for the users of Pyzeebe - which of course is fair, we're working with a pre-1.0 product so that is to be expected. We should then have a migration guide to ease the "pain".

I have a few suggestions that comes to mind:

• Enable watch by default for workers
• Enable more environment variables - Use environment variables to configure Zeebe #81

I would like to try to do a PR on #81 and #103, and can help with the migration guide as well - do we have a due date on when this needs to be in place?

• Asyncio support

This one is a large undertaking, but I can see how introducing this can enable more users to use Pyzeebe (e.g. wanting to migrate from Kafka based Async workers, without asyncio support that would mean a large rewrite).

One concern here is how to support both the threaded workers and the async workers. I can imagine we'll have the job handlers remain threaded, and use asyncio within each thread?

We should open an issue on this to discuss this further. I'm not sure 3.0 should depend on this though (we could plan for it, and introduce it in 3.1).

It would also be nice if we could create pre-releases from the develop branch.

[kbakk]

Can we create a milestone for this?

[JonatanMartens]

Docs for the 3.0.0 pre-release can be found here: https://pyzeebe.readthedocs.io/en/pre-release-3.0.0/

[JonatanMartens]

finally released :)