spiffworkflow
A powerful workflow engine implemented in pure Python
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 52 committers (1.9%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.0%) to scientific vocabulary
Keywords
Repository
A powerful workflow engine implemented in pure Python
Basic Info
Statistics
- Stars: 1,807
- Watchers: 88
- Forks: 332
- Open Issues: 10
- Releases: 0
Topics
Metadata Files
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 that's it! Built with - lxml
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.
- 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
pip install spiffworkflow[dev]
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
Owner
- Name: Sartography
- Login: sartography
- Kind: organization
- Email: dan@sartography.com
- Location: United States of America
- Website: sartography.com
- Repositories: 52
- Profile: https://github.com/sartography
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use SpiffWorkflow in your work, please cite it as follows."
title: "SpiffWorkflow"
version: "3.1.1"
doi: "10.5281/zenodo.14966563"
date-released: "2025-03-04"
url: "https://github.com/sartography/SpiffWorkflow"
repository-code: "https://github.com/sartography/SpiffWorkflow"
license: "LGPL-3.0"
authors:
- family-names: "Esswein"
given-names: "Elizabeth"
affiliation: "Sartography"
- family-names: "Abels"
given-names: "Samuel"
affiliation: "Independent Developer"
- family-names: "Funk"
given-names: "Daniel"
orcid: "0000-0003-0723-2253"
affiliation: "Sartography"
- family-names: "Jon"
given-names: "Herron"
affiliation: "Sartography"
- family-names: "McDonald"
given-names: "Kelly"
affiliation: "Sartography"
GitHub Events
Total
- Create event: 8
- Release event: 3
- Issues event: 4
- Watch event: 123
- Delete event: 5
- Issue comment event: 9
- Push event: 13
- Pull request review event: 2
- Pull request review comment event: 3
- Pull request event: 10
- Fork event: 23
Last Year
- Create event: 8
- Release event: 3
- Issues event: 4
- Watch event: 123
- Delete event: 5
- Issue comment event: 9
- Push event: 13
- Pull request review event: 2
- Pull request review comment event: 3
- Pull request event: 10
- Fork event: 23
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Elizabeth Esswein | e****n@g****m | 402 |
| Dan | d****k@g****m | 296 |
| Kelly McDonald | k****y@f****t | 249 |
| Matthew Hampton | m****n@g****m | 221 |
| Samuel Abels | k****p@g****m | 216 |
| Jon Herron | j****n@y****m | 96 |
| Ziad Sawalha | g****b@h****m | 35 |
| Aaron Louie | a****e@g****m | 28 |
| jasquat | j****t | 28 |
| Daniel Axtens | d****l@a****t | 24 |
| knipknap | k****p@e****7 | 18 |
| mike cullerton | m****c@c****m | 16 |
| Martijn Faassen | f****n@s****m | 15 |
| burnettk | b****k | 12 |
| Filipe Correia | f****a@g****m | 12 |
| Krzysztof Boguś | k****s@g****m | 10 |
| Antti Haapala | a****i@h****e | 8 |
| Leon | L****4 | 5 |
| Brian Soby | s****y@a****m | 4 |
| Chris Nesbitt-Smith | c****s@c****k | 4 |
| Jose Plana | j****a@g****m | 4 |
| fzzylogic | f****c | 4 |
| Randall Burt | r****t@r****m | 3 |
| davidl | d****r@s****m | 3 |
| Aaron Louie | a****n@s****m | 3 |
| Denny Weinberg | d****g@o****e | 2 |
| neilc | n****c@s****m | 2 |
| mmcardle | m****e@s****m | 2 |
| Tim Gates | t****s@i****m | 2 |
| wanze | a****2@o****m | 1 |
| and 22 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 57
- Total pull requests: 147
- Average time to close issues: 2 months
- Average time to close pull requests: 2 days
- Total issue authors: 28
- Total pull request authors: 13
- Average comments per issue: 1.91
- Average comments per pull request: 0.76
- Merged pull requests: 135
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 11
- Average time to close issues: N/A
- Average time to close pull requests: 2 minutes
- Issue authors: 3
- Pull request authors: 4
- Average comments per issue: 1.0
- Average comments per pull request: 0.27
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- danfunk (10)
- essweine (10)
- asauve2 (6)
- yyscamper (3)
- usama9500 (3)
- burnettk (2)
- H0nGzA1 (2)
- george-0-huang (2)
- shazz (2)
- calexh-sar (1)
- imrushi (1)
- cjdxhjj (1)
- vkuehn (1)
- fembau (1)
- renlycat (1)
Pull Request Authors
- essweine (106)
- jbirddog (18)
- danfunk (16)
- fzzylogic (6)
- jasquat (5)
- burnettk (3)
- subhakarks (3)
- lesnek (2)
- Leon0824 (2)
- mnbecker2002 (1)
- dmaljovec (1)
- anthuswilliams (1)
- rachfop (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 4
-
Total downloads:
- pypi 5,631 last-month
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 47
- Total maintainers: 7
proxy.golang.org: github.com/sartography/spiffworkflow
- Documentation: https://pkg.go.dev/github.com/sartography/spiffworkflow#section-documentation
- License: lgpl-3.0
-
Latest release: v3.1.1+incompatible
published 11 months ago
Rankings
proxy.golang.org: github.com/sartography/SpiffWorkflow
- Documentation: https://pkg.go.dev/github.com/sartography/SpiffWorkflow#section-documentation
- License: lgpl-3.0
-
Latest release: v3.1.1+incompatible
published 11 months ago
Rankings
pypi.org: spiffworkflow
A workflow framework and BPMN/DMN Processor
- Homepage: https://github.com/sartography/SpiffWorkflow
- Documentation: https://spiffworkflow.readthedocs.io
- License: lGPLv3
-
Latest release: 3.1.1
published 11 months ago
Rankings
Maintainers (6)
pypi.org: edaspiffworkflow
A WF Manager for EDA with Spiff
- Homepage: https://github.com/sartography/SpiffWorkflow
- Documentation: https://edaspiffworkflow.readthedocs.io/
- License: lGPLv2
-
Latest release: 0.0.2
published over 3 years ago
Rankings
Maintainers (1)
Dependencies
- celery *
- coverage *
- dateparser *
- lxml *
- pytz *
- celery *
- configparser *
- dateparser *
- lxml *
- pytz *
- actions/checkout master composite
- actions/setup-python v1 composite
- pypa/gh-action-pypi-publish master composite
- python 3.6 build
- actions/checkout v3 composite
- actions/setup-python v4 composite