f1b8cfcc07
96ad2a2b0 Merge pull request #311 from sartography/feature/error-message-on-bad-child-task 3fb69038d Merge remote-tracking branch 'origin/main' into feature/error-message-on-bad-child-task df703ebb8 Merge remote-tracking branch 'origin/feature/add_task_not_found_error' d6e244bcf also raise TaskNotFoundException from bpmn workflow w/ burnettk 37d7ae679 Merge pull request #310 from sartography/feature/add_task_not_found_error 7f4d38ce2 give us a better error if for some reason a task does not exist b98efbd20 added an exception for task not found w/ burnettk e1add839d Merge pull request #308 from sartography/bugfix/execute-event-gateways-on-ready 964c0231a do not predict tasks when deserializing, add method to predict all unfinished tasks 114f87aa9 update event gateway 62454c99c Merge pull request #307 from sartography/feature/standardize-task-execution a087d29ea update task_spec._run to return a boolean & misc cleanup 9864d753d reenable recursion test 1bb1246a0 rename methods & move ready_before tasks from run to ready 12ce08519 move event task execution to run d51bb68eb cleanup predictions 5e05458a3 make all tasks execute when run rather than completed (except bpmn events) 273d7b325 create a run method for tasks 3c3345c85 Merge pull request #306 from sartography/feature/create-core-test-package ed85547d7 hopefully fix CI job, also update some deprecated assertions 80d68c231 cleanup around finding tasks ea5ffff41 create tests based on individual patterns afe41fba1 move core tests into one package c075d52bc remove locks from task spec -- they don't do anything d78c7cc04 reorganize so that related methods are near each other f162aac43 Merge pull request #305 from sartography/feature/remove-loop-reset 6cad29817 'fix' old serializer to remove loop resets -- or at least get the tests to pass a95d2fc12 add serialization migration that removes loop resets c076175c8 account for DST in timers 42b483054 Merge pull request #303 from sartography/bugfix/execute-tasks-on-ready 2bb08aae1 update script/service tasks to execute on ready 0bd23a0ab fix scripts in business rule tasks 13034aaf1 prevent loop reset tasks from being inserted 3fb80518d update join execution model git-subtree-dir: SpiffWorkflow git-subtree-split: 96ad2a2b060deb445c39374f065690023351de19 |
||
|---|---|---|
| .github/workflows | ||
| doc | ||
| graphics | ||
| scripts | ||
| tests | ||
| .editorconfig | ||
| .flake8 | ||
| .gitignore | ||
| .readthedocs.yml | ||
| .sonarcloud.properties | ||
| .tool-versions | ||
| .travis.yml | ||
| AUTHORS | ||
| CONTRIB | ||
| COPYING | ||
| Dockerfile | ||
| INSTALL | ||
| Makefile | ||
| README.md | ||
| TODO | ||
| VERSION.in | ||
| pyproject.toml | ||
| requirements.txt | ||
| setup.py | ||
| sonar-project.properties | ||
| 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