cb4d72445d
b439f69f2 Merge pull request #296 from sartography/bugfix/subprocess-access-to-data-objects 6d2a2031e update spiff subworkflow tasks too 992c38671 make data objects referenceable within subprocesses 6c8ff5cdf allow subprocesses & call activities to have different data copy policies 2b14f3a48 initialize subprocesses in _update_hook instead of _on_ready_before 791f335d5 Merge pull request #295 from sartography/improvement/remove-camunda-from-base-and-misc-cleanup 28b579beb remove a few unused, duplicative, and debugging methods 8f14d1098 remove some other unused diagrams and tests 408bc6734 rely on top level camunda parser for almost all namespace references 895b2cc9b remove camunda namespace from base bpmn parser 76ecbf7cc Merge pull request #294 from sartography/bugfix/reactivate-boundary-event 82b6c8ad4 hack to ensure timers (and other events) are reset if returned to via loop reset 590903f47 Merge pull request #292 from sartography/feature/multiinstance-refactor 537490043 fix bug & typo f31726db1 raise error on attempting to migrate workflows with MI 44e6d08d8 create spiff multiinstance task 2168c022b create camunda MI that approximates what it used to do 9894cea59 some improvements and bugfixes f857ad5d4 remove some now unused functionality & tests, create a few more tests 6fead9d04 updated serializer & fixes for most tests ec662ecdd add parallel multiinstance bd19b2a8a working sequential multiinstance 2f9c192b6 further cleanup around _update_hook 947792bf6 fix bug in exclusive gateway migration d3d87b28d add io spec to all tasks f1586e275 add support for standard loop tasks git-subtree-dir: SpiffWorkflow git-subtree-split: b439f69f23b547df4de1e8e0c636997f2fd4e33b
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