38ff7e08da
0adfc8cb update spiff signal event 52d65dfc Merge pull request #346 from sartography/bugfix/update-split-task-inputs 23ca808c make sure tasks with boundary events are connected properly de427431 remove pointless parser attribute and variable 3236b5b9 change subprocess start event validation error message text a5ad0672 Merge pull request #344 from sartography/bugfix/gateway-in-loop 6b22a195 allow event definitions without refs bb843873 clean up inclusive gateway a little a7d81c02 prevent parallel gateways from waiting on descendants 802352a2 move test to proper location ebcdde95 Merge pull request #343 from sartography/feature/event-payloads 87636472 add an additional test for boundary event parent removal 41423168 add escalation event test 26c5a9bb fix message event catch check 9bd018e5 Add test case for call activities in sub processes, fixed bug (#342) 546923b4 add serialization migration for boundary events 46d41e20 add spiff payload extensions + base spec improvements a0f5fc2a remove boundary event parent 56277ff1 add event class 6de6fb2b reorganize event definitions 7db65566 fix subprocess cancel 442535ae do not allow the task trace to infinitely loop to get the trace w/ burnettk dbe41c8e Merge pull request #339 from sartography/improvement/better-subworkflow-management 6c61f20a update parent attribute name ea0a7bf4 update correlations when catching external messages f511e2dd remove unneeded method from tests 953fa63c clean up workflow methods efcdcf54 Merge pull request #338 from sartography/bugfix/triggered-multiinstance-tasks 11b78ce7 prevent errors synching children of MI tasks bbb79e05 miscellaneous improvements 3f8e8d84 split bpmn workflow into two classes 61e01201 clean up workflow attributes & methods git-subtree-dir: SpiffWorkflow git-subtree-split: 0adfc8cbaec80d36f98a4136434e960f666fcfe2 |
||
|---|---|---|
| .github/workflows | ||
| doc | ||
| graphics | ||
| scripts | ||
| tests | ||
| .editorconfig | ||
| .flake8 | ||
| .gitignore | ||
| .readthedocs.yml | ||
| .tool-versions | ||
| .travis.yml | ||
| AUTHORS | ||
| CONTRIB | ||
| COPYING | ||
| Dockerfile | ||
| INSTALL | ||
| Makefile | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| TODO | ||
| VERSION.in | ||
| pyproject.toml | ||
| requirements.txt | ||
| setup.py | ||
| unit_test_extensions.patch | ||
| version.sh | ||
README.md
SpiffWorkflow
Spiff Workflow is a workflow engine implemented in pure Python. It is based on the excellent work of the Workflow Patterns initiative. In 2020 and 2021, extensive support was added for BPMN / DMN processing.
Motivation
We created SpiffWorkflow to support the development of low-code business applications in Python. Using BPMN will allow non-developers to describe complex workflow processes in a visual diagram, coupled with a powerful python script engine that works seamlessly within the diagrams. SpiffWorkflow can parse these diagrams and execute them. The ability for businesses to create clear, coherent diagrams that drive an application has far reaching potential. While multiple tools exist for doing this in Java, we believe that wide adoption of the Python Language, and it's ease of use, create a winning strategy for building Low-Code applications.
Build status
Code style
Dependencies
We've worked to minimize external dependencies. We rely on lxml for parsing XML Documents, and there is some legacy support for Celery, but it is not core to the implementation, it is just a way to interconnect these systems. Built with
Features
- BPMN - support for parsing BPMN diagrams, including the more complex components, like pools and lanes, multi-instance tasks, sub-workflows, timer events, signals, messages, boudary events and looping.
- DMN - We have a baseline implementation of DMN that is well integrated with our Python Execution Engine.
- Forms - forms, including text fields, selection lists, and most every other thing you can be extracted from the Camunda xml extension, and returned as json data that can be used to generate forms on the command line, or in web applications (we've used Formly to good success)
- Python Workflows - We've retained support for building workflows directly in code, or running workflows based on a internal json data structure.
A complete list of the latest features is available with our release notes for version 1.0.
Code Examples and Documentation
Detailed documentation is available on ReadTheDocs Also, checkout our example application, which we reference extensively from the Documentation.
Installation
pip install spiffworkflow
Tests
cd tests/SpiffWorkflow
coverage run --source=SpiffWorkflow -m unittest discover -v . "*Test.py"
Support
You can find us on Discord at https://discord.gg/BYHcc7PpUC
Commercial support for SpiffWorkflow is available from Sartography
Contribute
Pull Requests are and always will be welcome!
Please check your formatting, assure that all tests are passing, and include any additional tests that can demonstrate the new code you created is working as expected. If applicable, please reference the issue number in your pull request.
Credits and Thanks
Samuel Abels (@knipknap) for creating SpiffWorkflow and maintaining it for over a decade.
Matthew Hampton (@matthewhampton) for his initial contributions around BPMN parsing and execution.
The University of Virginia for allowing us to take on the mammoth task of building a general-purpose workflow system for BPMN, and allowing us to contribute that back to the open source community. In particular, we would like to thank Ron Hutchins, for his trust and support. Without him our efforts would not be possible.
Bruce Silver, the author of BPMN Quick and Easy Using Method and Style, whose work we referenced extensively as we made implementation decisions and educated ourselves on the BPMN and DMN standards.
The BPMN.js library, without which we would not have the tools to effectively build out our models, embed an editor in our application, and pull this mad mess together.
Kelly McDonald (@w4kpm) who dove deeper into the core of SpiffWorkflow than anyone else, and was instrumental in helping us get some of these major enhancements working correctly.
Thanks also to the many contributions from our community. Large and small. From Ziad (@ziadsawalha) in the early days to Elizabeth (@essweine) more recently. It is good to be a part of this long lived and strong community.
License
GNU LESSER GENERAL PUBLIC LICENSE