Spiffworkflow

What's Changed

We've done a lot of work over the last 8 months to the SpiffWorkflow library as we've developed [SpiffArena](https://www.spiffworkflow.org/), a general purpose workflow management system built on top of this library.
This has resulted in a handful of new features.
Our main focus was on making SpiffWorkflow more predictable, easier to use, and internally consistent.

Breaking Changes from 1.x:
* We heavily refactored the way we handle multi-instance tasks internally. This will break any serialized workflows that contain multi-instance tasks.
* Internal structure of our code, the names of some classes, and common methods have changed. Please see our [ReadTheDocs] (https://readthedocs.org/projects/spiffworkflow/) documenation for version 2.0.0.

Features and Improvements

Task States, Transitions, Hooks, and Execution
Previous to 2.0, SpiffWorklow was a little weird about its states, performing the actual execution in the on_complete() hook.
This was VERY confusing.
Tasks now have a _run() command separate from state change hooks.
The return value of the _run() command can be true (worked), false (failure), or None (not yet done).
This opens the door for better overall state management at the moment it is most critical (when the task is actually executing).
We also added new task state called "STARTED" that describes when a task was started, but hasn't finished yet, an oddly missing state in previous versions.

* Improvement/execution and serialization cleanup by essweine in https://github.com/sartography/SpiffWorkflow/pull/289
* Bugfix/execute tasks on ready by essweine in https://github.com/sartography/SpiffWorkflow/pull/303
* Feature/standardize task execution by essweine in https://github.com/sartography/SpiffWorkflow/pull/307
* do not execute boundary events in catch by essweine in https://github.com/sartography/SpiffWorkflow/pull/312
* Feature/new task states by essweine in https://github.com/sartography/SpiffWorkflow/pull/315

Improved Events
We refactored the way we handle events, making them more powerful and adaptable.
Timer events are now parsed according to the [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601).
* Feature/multiple event definition by essweine in https://github.com/sartography/SpiffWorkflow/pull/268
* hacks to handle timer events like regular events by essweine in https://github.com/sartography/SpiffWorkflow/pull/273
* Feature/improved timer events by essweine in https://github.com/sartography/SpiffWorkflow/pull/284
* reset boundary events in loops by essweine in https://github.com/sartography/SpiffWorkflow/pull/294
* Bugfix/execute event gateways on ready by essweine in https://github.com/sartography/SpiffWorkflow/pull/308

Improved Multi-Instance Tasks
We refactored how Multi-instance tasks are handled internally, vastly simplifying their representation during execution and serialization.
No more 'phantom gateways.'
* Feature/multiinstance refactor by essweine in https://github.com/sartography/SpiffWorkflow/pull/292

Improved SubProcesses
SpiffWorkflow did not previously distinguish between a Call Activity and a SubProcess, but they handle Data Objects very differently.
A SubProcess is now able to access its parent data objects, a Call Activity can not.
We also wanted the ability to execute Call Activities independently of the parent process.

* Bugfix/subprocess access to data objects by essweine in https://github.com/sartography/SpiffWorkflow/pull/296
* start workflow while subprocess is waiting by essweine in https://github.com/sartography/SpiffWorkflow/pull/302
* use same data objects & references in subprocesses after deserialization by essweine in https://github.com/sartography/SpiffWorkflow/pull/314

Improved Data Objects / Data Stores
This work will continue in subsequent releases, but we have added support for Data Stores, and it is possible to provide your own implementations.
* Data stores by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/298
* make data objects available to gateways by essweine in https://github.com/sartography/SpiffWorkflow/pull/325

Improved Inclusive Gateways
We added support for Inclusive Gateways.
* Feature/inclusive gateway support by essweine in https://github.com/sartography/SpiffWorkflow/pull/286

Pre and Post Script Fixes
We previously supported adding a pre-script or post-script to any task but there were a few lingering bugs that needed fixing.
* parse spiff script extensions in service tasks by essweine in https://github.com/sartography/SpiffWorkflow/pull/257
* pass script to workflow task exec exception by essweine in https://github.com/sartography/SpiffWorkflow/pull/258
* update execution order for postscripts by essweine in https://github.com/sartography/SpiffWorkflow/pull/259

DMN Improvements
We now support a new hit policy of "COLLECT" which allows you to match on an array of items. DMN support is still limited, but
we are making headway. We would love to know if people are using these features.
* Support for the "COLLECT" hit policy. by danfunk in https://github.com/sartography/SpiffWorkflow/pull/267
* Bugfix/handle dash in DMN by essweine in https://github.com/sartography/SpiffWorkflow/pull/323

BPMN Validation
We improved validation of BPMN and DMN Files to catch errors earlier.
* Feature/xml validation by essweine and danfunk in https://github.com/sartography/SpiffWorkflow/pull/256

New Serializer
There are some breaking changes in the new serializer, but it is much faster and more stable. We do attempt to upgrade
your serialized workflows to the new format, but you will definitely encounter issues if you were using multi-instance tasks.
* update serializer version by essweine in https://github.com/sartography/SpiffWorkflow/pull/277
* Feature/remove old serializer by essweine in https://github.com/sartography/SpiffWorkflow/pull/278

Lightning Fast, Stable Tests
* Fix ResourceWarning: unclosed file BpmnParser.py:60 by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/270
* Option to run tests in parallel by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/271

Better Errors
* Feature/better errors by danfunk in https://github.com/sartography/SpiffWorkflow/pull/283
* Workflow Data Exceptions were broken in the previous error refactor. … by danfunk in https://github.com/sartography/SpiffWorkflow/pull/287
* added an exception for task not found w/ burnettk by jasquat in https://github.com/sartography/SpiffWorkflow/pull/310
* give us a better error if for some reason a task does not exist by burnettk in https://github.com/sartography/SpiffWorkflow/pull/311

Flexible Data Management
* Allow for other PythonScriptEngine environments besides task data by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/288

Various Enhancements
Make it easier to reference SpiffWorkflow library classes from your own code.
* Feature/add init to schema by jasquat in https://github.com/sartography/SpiffWorkflow/pull/260
* cleaning up code smell by danfunk in https://github.com/sartography/SpiffWorkflow/pull/261
* Feature/cleanup task completion by essweine in https://github.com/sartography/SpiffWorkflow/pull/263
* disambiguate DMN expressions by essweine in https://github.com/sartography/SpiffWorkflow/pull/264
* Add in memory BPMN/DMN parser functions by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/320

Better Introspection
Added the ability to ask SpiffWorkflow some useful questions about a specification such as, "What call activities does this depend on?",
"What messages does this process send and receive", and "What lanes exist on this workflow specification?"
* Parser Information about messages, correlation keys, and the presence of lanes by danfunk in https://github.com/sartography/SpiffWorkflow/pull/262
* Called elements by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/316

Code Cleanup
* Improvement/task spec attributes by essweine in https://github.com/sartography/SpiffWorkflow/pull/328
* update license by essweine in https://github.com/sartography/SpiffWorkflow/pull/324
* Feature/remove unused BPMN attributes and methods by essweine in https://github.com/sartography/SpiffWorkflow/pull/280
* Improvement/remove camunda from base and misc cleanup by essweine in https://github.com/sartography/SpiffWorkflow/pull/295
* remove minidom by essweine in https://github.com/sartography/SpiffWorkflow/pull/300
* Feature/remove loop reset by essweine in https://github.com/sartography/SpiffWorkflow/pull/305
* Feature/create core test package by essweine in https://github.com/sartography/SpiffWorkflow/pull/306
* remove celery task and dependency by essweine in https://github.com/sartography/SpiffWorkflow/pull/322
* remove one deprecated and unused feature by essweine in https://github.com/sartography/SpiffWorkflow/pull/329
* change the order of tasks when calling get_tasks() by danfunk in https://github.com/sartography/SpiffWorkflow/pull/319

Improved Documentation
* Fixes grammar, typos, and spellings by rachfop in https://github.com/sartography/SpiffWorkflow/pull/291
* Updates for 2.0 release by essweine in https://github.com/sartography/SpiffWorkflow/pull/330
* Bugfix/non BPMN tutorial by essweine in https://github.com/sartography/SpiffWorkflow/pull/317

Bug Fixes
* correct xpath for extensions by essweine in https://github.com/sartography/SpiffWorkflow/pull/265
* prevent output associations from being removed twice by essweine in https://github.com/sartography/SpiffWorkflow/pull/275
* fix for workflowspec dump by subhakarks in https://github.com/sartography/SpiffWorkflow/pull/282
* add checks for len == 0 when copying based on io spec by essweine in https://github.com/sartography/SpiffWorkflow/pull/297
* Improvement/allow duplicate subprocess names by essweine in https://github.com/sartography/SpiffWorkflow/pull/321
* Resets to tasks with Boundary Events by danfunk in https://github.com/sartography/SpiffWorkflow/pull/326
* Sub-workflow tasks should be marked as "Future" when resetting to a task before the sub-process. by danfunk in https://github.com/sartography/SpiffWorkflow/pull/327

New Contributors
* subhakarks made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/282
* rachfop made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/291

**Full Changelog**: https://github.com/sartography/SpiffWorkflow/compare/v1.2.1...v2.0.0

What's Changed

We've done a lot of work over the last 8 months to the SpiffWorkflow library as we've developed [SpiffArena](https://www.spiffworkflow.org/), a general purpose workflow management system built on top of this library.
This has resulted in just a handful of new features.
Our main focus was on making SpiffWorkflow more predictable, easier to use, and internally consistent.

Breaking Changes from 1.x:
* We heavily refactored the way we handle multi-instance tasks internally. This will break any serialized workflows that contain multi-instance tasks.
* Internal structure of our code, the names classes, and common methods have changed. Please see our [ReadTheDocs] (https://readthedocs.org/projects/spiffworkflow/) documenation for version 2.0.0.

Features and Improvements

Task States, Transitions, Hooks, and Execution
Previous to 2.0, SpiffWorklow was a little weird about its states, performing the actual execution in the on_complete() hook.
This was VERY confusing.
Tasks now have a _run() command separate from state change hooks.
The return value of the _run() command can be true (worked), false (failure), or None (not yet done).
This opens the door for better overall state management at the moment it is most critical (when the task is actually executing).
We also added new task state called "STARTED" that describes when a task was started, but hasn't finished yet, an oddly missing state in previous versions.

* Improvement/execution and serialization cleanup by essweine in https://github.com/sartography/SpiffWorkflow/pull/289
* Bugfix/execute tasks on ready by essweine in https://github.com/sartography/SpiffWorkflow/pull/303
* Feature/standardize task execution by essweine in https://github.com/sartography/SpiffWorkflow/pull/307
* do not execute boundary events in catch by essweine in https://github.com/sartography/SpiffWorkflow/pull/312
* Feature/new task states by essweine in https://github.com/sartography/SpiffWorkflow/pull/315

Improved Events
We refactored the way we handle events, making them more powerful and adaptable.
Timer events are now parsed according to the [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601).
* Feature/multiple event definition by essweine in https://github.com/sartography/SpiffWorkflow/pull/268
* hacks to handle timer events like regular events by essweine in https://github.com/sartography/SpiffWorkflow/pull/273
* Feature/improved timer events by essweine in https://github.com/sartography/SpiffWorkflow/pull/284
* reset boundary events in loops by essweine in https://github.com/sartography/SpiffWorkflow/pull/294
* Bugfix/execute event gateways on ready by essweine in https://github.com/sartography/SpiffWorkflow/pull/308

Improved Multi-Instance Tasks
We refactored how Multi-instance tasks are handled internally, vastly simplifying their representation during execution and serialization.
No more 'phantom gateways.'
* Feature/multiinstance refactor by essweine in https://github.com/sartography/SpiffWorkflow/pull/292

Improved SubProcesses
SpiffWorkflow did not previously distinguish between a Call Activity and a SubProcess, but they handle Data Objects very differently.
A SubProcess is now able to access its parent data objects, a Call Activity can not.
We also wanted the ability to execute Call Activities independently of the parent process.

* Bugfix/subprocess access to data objects by essweine in https://github.com/sartography/SpiffWorkflow/pull/296
* start workflow while subprocess is waiting by essweine in https://github.com/sartography/SpiffWorkflow/pull/302
* use same data objects & references in subprocesses after deserialization by essweine in https://github.com/sartography/SpiffWorkflow/pull/314

Improved Data Objects / Data Stores
This work will continue in subsequent releases, but we have added support for Data Stores, and it is possible to provide your own implementations.
* Data stores by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/298
* make data objects available to gateways by essweine in https://github.com/sartography/SpiffWorkflow/pull/325

Improved Inclusive Gateways
We added support for Inclusive Gateways.
* Feature/inclusive gateway support by essweine in https://github.com/sartography/SpiffWorkflow/pull/286

Pre and Post Script Fixes
We previously supported adding a pre-script or post-script to any task but there were a few lingering bugs that needed fixing.
* parse spiff script extensions in service tasks by essweine in https://github.com/sartography/SpiffWorkflow/pull/257
* pass script to workflow task exec exception by essweine in https://github.com/sartography/SpiffWorkflow/pull/258
* update execution order for postscripts by essweine in https://github.com/sartography/SpiffWorkflow/pull/259

DMN Improvements
We now support a new hit policy of "COLLECT" which allows you to match on an array of items. DMN support is still limited, but
we are making headway. We would love to know if people are using these features.
* Support for the "COLLECT" hit policy. by danfunk in https://github.com/sartography/SpiffWorkflow/pull/267
* Bugfix/handle dash in DMN by essweine in https://github.com/sartography/SpiffWorkflow/pull/323

BPMN Validation
We improved validation of BPMN and DMN Files to catch errors earlier.
* Feature/xml validation by essweine and danfunk in https://github.com/sartography/SpiffWorkflow/pull/256

New Serializer
There are some breaking changes in the new serializer, but it is much faster and more stable. We do attempt to upgrade
your serialized workflows to the new format, but you will definitely encounter issues if you were using multi-instance tasks.
* update serializer version by essweine in https://github.com/sartography/SpiffWorkflow/pull/277
* Feature/remove old serializer by essweine in https://github.com/sartography/SpiffWorkflow/pull/278

Lightning Fast, Stable Tests
* Fix ResourceWarning: unclosed file BpmnParser.py:60 by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/270
* Option to run tests in parallel by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/271

Better Errors
* Feature/better errors by danfunk in https://github.com/sartography/SpiffWorkflow/pull/283
* Workflow Data Exceptions were broken in the previous error refactor. … by danfunk in https://github.com/sartography/SpiffWorkflow/pull/287
* added an exception for task not found w/ burnettk by jasquat in https://github.com/sartography/SpiffWorkflow/pull/310
* give us a better error if for some reason a task does not exist by burnettk in https://github.com/sartography/SpiffWorkflow/pull/311

Flexible Data Management
* Allow for other PythonScriptEngine environments besides task data by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/288

Various Enhancements
Make it easier to reference SpiffWorkflow library classes from your own code.
* Feature/add init to schema by jasquat in https://github.com/sartography/SpiffWorkflow/pull/260
* cleaning up code smell by danfunk in https://github.com/sartography/SpiffWorkflow/pull/261
* Feature/cleanup task completion by essweine in https://github.com/sartography/SpiffWorkflow/pull/263
* disambiguate DMN expressions by essweine in https://github.com/sartography/SpiffWorkflow/pull/264
* Add in memory BPMN/DMN parser functions by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/320

Better Introspection
Added the ability to ask SpiffWorkflow some useful questions about a specification such as, "What call activities does this depend on?",
"What messages does this process send and receive", and "What lanes exist on this workflow specification?"
* Parser Information about messages, correlation keys, and the presence of lanes by danfunk in https://github.com/sartography/SpiffWorkflow/pull/262
* Called elements by jbirddog in https://github.com/sartography/SpiffWorkflow/pull/316

Code Cleanup
* Improvement/task spec attributes by essweine in https://github.com/sartography/SpiffWorkflow/pull/328
* update license by essweine in https://github.com/sartography/SpiffWorkflow/pull/324
* Feature/remove unused BPMN attributes and methods by essweine in https://github.com/sartography/SpiffWorkflow/pull/280
* Improvement/remove camunda from base and misc cleanup by essweine in https://github.com/sartography/SpiffWorkflow/pull/295
* remove minidom by essweine in https://github.com/sartography/SpiffWorkflow/pull/300
* Feature/remove loop reset by essweine in https://github.com/sartography/SpiffWorkflow/pull/305
* Feature/create core test package by essweine in https://github.com/sartography/SpiffWorkflow/pull/306
* remove celery task and dependency by essweine in https://github.com/sartography/SpiffWorkflow/pull/322
* remove one deprecated and unused feature by essweine in https://github.com/sartography/SpiffWorkflow/pull/329
* change the order of tasks when calling get_tasks() by danfunk in https://github.com/sartography/SpiffWorkflow/pull/319

Improved Documentation
* Fixes grammar, typos, and spellings by rachfop in https://github.com/sartography/SpiffWorkflow/pull/291
* Updates for 2.0 release by essweine in https://github.com/sartography/SpiffWorkflow/pull/330
* Bugfix/non BPMN tutorial by essweine in https://github.com/sartography/SpiffWorkflow/pull/317

Bug Fixes
* correct xpath for extensions by essweine in https://github.com/sartography/SpiffWorkflow/pull/265
* prevent output associations from being removed twice by essweine in https://github.com/sartography/SpiffWorkflow/pull/275
* fix for workflowspec dump by subhakarks in https://github.com/sartography/SpiffWorkflow/pull/282
* add checks for len == 0 when copying based on io spec by essweine in https://github.com/sartography/SpiffWorkflow/pull/297
* Improvement/allow duplicate subprocess names by essweine in https://github.com/sartography/SpiffWorkflow/pull/321
* Resets to tasks with Boundary Events by danfunk in https://github.com/sartography/SpiffWorkflow/pull/326
* Sub-workflow tasks should be marked as "Future" when resetting to a task before the sub-process. by danfunk in https://github.com/sartography/SpiffWorkflow/pull/327

New Contributors
* subhakarks made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/282
* rachfop made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/291

**Full Changelog**: https://github.com/sartography/SpiffWorkflow/compare/v1.2.1...v2.0.0

What's Changed
* do not install importlib-metadata if greater than python 3.7 w/ burnettk by jasquat in https://github.com/sartography/SpiffWorkflow/pull/253

New Contributors
* jasquat made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/253

**Full Changelog**: https://github.com/sartography/SpiffWorkflow/compare/v1.2.0...v1.2.1

Data Objects, Messages and Services
_Note: there are some minor breaking changes in this release, please see "Minor Breaking Changes and their Fixes" below for how to fix them._

This Version of SpiffWorkflow adds support for Data Objects, Messages, and Service Tasks. These are powerful new tools for managing workflows as they grow in complexity. Details below.

This is also our first step towards a larger ecosystem. One that includes a customized Diagram Editor that is still under development, but [available on GitHub](https://github.com/sartography/bpmn-js-spiffworkflow) and perfectly serviceable. You will need the editor to take full advantage of the new features mentioned above. A new project, code named SpiffArena is also under heavy development. SpiffArena will connect this SpiffWorkflow library to the new BPMN Editor and provide a complete Workflow Engine with a backend and frontend that can be configured to manage and execute a collection of your own BPMN diagrams. Keep an eye out for an initial release before the end of the year.

In addition to major new features, we've improved some existing core features. The Python Expression Engine is now easier to extend and modify for custom deployments, and SubProcesses have a far stronger and more consistent internal representation and are easier to control. We've also added the ability to unit test your script tasks - to make it much easier to write small python scripts to re-structure your data.

Finally, we undertook hours of effort to clean up the code base, so that imports are consistent, circular dependencies are removed, and code smells are eliminated. It is by no means perfect, but we are arcing in the right direction.

Major Changes
Data Objects, Inputs and Outputs
We now support Data Objects, providing powerful tools for controlling the scope and access of variables within a workflow.
For an overview of how Data Objects work, please check out our article ["Understanding BPMN Data Objects"](https://medium.com/danfunk/understanding-bpmns-data-objects-with-spiffworkflow-26e195e23398
). Detailed information is also available in our ReadTheDocs page.
* explicitly add data associations on serializing MI tasks by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/197)
* add messages to data object exceptions by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/222)

Messages
Communication between running workflow instances is a powerful tool as workflows become more complex. For a detailed overview of this topic, please check out our article ["Understanding BPMN Messages"](https://medium.com/p/7b0fee2d6a81)
* messages and business rules by burnettk in [PR](https://github.com/sartography/SpiffWorkflow/pull/211)
* messages no longer send all keys by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/213)

Service Tasks
Service Tasks are now supported, and offer an easy way for BPMN Developers to make calls to external APIs. Examples for
working with this critical new tool will be documented in our ReadTheDocs page.
* First pass of ServiceTask handling by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/205)
* Service task connector delegate by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/225)
* Store service task response in task data by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/227)
* get description aka name when parsing service tasks by burnettk in [PR](https://github.com/sartography/SpiffWorkflow/pull/241)
* Follow up on service task bug fix, quote string literals by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/244)
* Pass task data to service task delegate by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/248)

Custom BPMN Editor Support
Still in heavy development is a custom BPMN Editor, which you can find on [GitHub]([PR](https://github.com/sartography/bpmn-js-spiffworkflow).)
This new editor provides the tools that will make creating valid Service Tasks, Data Objects, and Messages possible.
Many thanks to the BPMN.js community for this highly extensible diagramming library!
* Support for Spiff pre/postscript extensions by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/190)
z* parses out spiffworklow:property tags in bpmn extensions and makes th… by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/191)

Improved Script Engine
A Script Engine that is overall easier to understand and extend.
* Feature/improved script engine by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/215)
* make globals an argument in the script engine by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/24)

Script Task Unit Testing
Added the ability to create, store, and execute assertions against Script Tasks. Allows you to define a Json data
structure as input, and an expected Json data structure as output. So you can assert your script is producing exactly
the right data.
* Script Task Unit Test Extensions (Attempt 2) by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/238)

New spec_type attribute
Given the ability to overload classes, and mix-in properties, it could be difficult to look at a Task Spec's class
to determine if it was a User Task or Script Task, etc... All Task Specs now have a spec_type attribute, containing a descriptive string of the type, expect to see "User Task", "Script Task", "Start Event" etc...
* add spec type property to task specs with BPMN names by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/231)

Improved Subprocess Handling
* Allows recursive calls to subprocesses, and improves serialization and execution by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/187)
* add bpmn spec mixin functionality to subworkflow tasks by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/226)
* handle all data copying in bpmn subworkflow task by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/243)

Vastly Faster Tests!
* Profile and improve run time of the test suite by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/204)
* Improve test suite run time, part 2 by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/207)
* ParallelTest.py split by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/208)
* Up some sleep times in tests for CI stability by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/224)

Bug Fixes
* fix loop reset task to handle multiple subprocess properly by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/192)
* Bugfix/separate subprocess dict for serializer by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/196)
* Update make tests to run tests per the README, remove unused test runners by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/202)
* Bug/service task variable by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/233)
* Fix for failures with Python 3.7 by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/240)

Code Cleanup and Documentation Changes
* Support custom JSON encoder/decoder in BpmnWorkflowSerializer by soby in [PR](https://github.com/sartography/SpiffWorkflow/pull/220)
* Add Python 3.10 to CI by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/242)
* list dependencies by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/217)
* Feature/centralized logging by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/21)
* [FIX] Use self.spec_class instead of direct use of base object by Giulios74 in [PR](https://github.com/sartography/SpiffWorkflow/pull/186)
* add more documentation about serializer migration by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/188)
* docs: Fix a few typos by timgates42 in [PR](https://github.com/sartography/SpiffWorkflow/pull/193)
* Fix a few docstring typos in the tests by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/203)
* Remove unused imports by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/209)
* Reorganized parser [PR](https://github.com/sartography/SpiffWorkflow/pull/206)
* fix for a serialization bug by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/216)
* fix serialization bug by essweine in [PR](https://github.com/sartography/SpiffWorkflow/pull/219)
* Don't use bpmn exception from core spec by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/228)
* added task name to the spiff logs by burnettk in [PR](https://github.com/sartography/SpiffWorkflow/pull/232)
* Remove navigation.py, tests and related bpmn files by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/230)
* Remove bpmn imports from task.py by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/234)
* Remove bpmn references from dict.py and json.py by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/236)
* Remove some lingering bpmn imports by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/239)
* Empty SpiffWorkflow/__init__.py by jbirddog in [PR](https://github.com/sartography/SpiffWorkflow/pull/245)
* Various fixes as I attempted to get our CR-Connect application working against the lastest SpiffWorkflow build by danfunk in [PR](https://github.com/sartography/SpiffWorkflow/pull/247)


Minor Breaking Changes and their Fixes
This Minor Release includes a few minor breaking changes that should be easy
to correct. Please apply these fixes as appropriate

1. Top Level Imports moved to appropriate modules

REPLACE 'from SpiffWorkflow import WorkflowException'
WITH 'from SpiffWorkflow.exceptions import WorkflowException'


REPLACE 'from SpiffWorkflow import TaskState'
WITH: 'from SpiffWorkflow.task import TaskState'


REPLACE: 'from SpiffWorkflow import Task'
WITH 'from SpiffWorkflow.task import Task'

2. Navigation code was removed
- Proved to be of little use to folks, was super complex and difficult to maintain.
- If you depended on this code, you can take the original code and embed it in your project.
3. remove all references of timeit (no longer in SpiffWorkflow)
- timing is now available for all tasks in the spiff.metrics log without having to edit the code
- Same as above, this standalone code can be added to your code if needed.
4. pythonScriptEngine._evaluate no longer accepts a task argument.
If you were overriding this method for some reason, please change your method signature
5. If you were previously using the workflow.signal() or workflow.message() functions, these should be replaced with
workflow.catch().
6. Task States are JUST integers and TaskSpecNames is now a public dictionary, and can be used to covert a state to human readable string

REPLACE: user_task.state.name
WITH: TaskStateNames[user_task.state]


Other Notes
1. When inserting custom functions into the PythonExecutionEngine - be aware that the task data will act as the full context for execution, and will contain global functions and methods during the exec call.

New Contributors
* Giulios74 made their first contribution in [PR](https://github.com/sartography/SpiffWorkflow/pull/186)
* jbirddog made their first contribution in [PR](https://github.com/sartography/SpiffWorkflow/pull/202)
* burnettk made their first contribution in [PR](https://github.com/sartography/SpiffWorkflow/pull/211)

**Full Changelog**: [PR](https://github.com/sartography/SpiffWorkflow/compare/v1.1.7...v1.2)

What's Changed
This push covers a major overhaul of our JSON serializer, which previously depended on using pickle making the json difficult to read and parse outside of Spiff and creating some potential security concerns.

**IMPORTANT:** If you have existing workflows stored as JSON you will need to migrate them to the new version, you can do this on the fly by following the [Migration Instructions](https://spiffworkflow.readthedocs.io/en/latest/bpmn/advanced.html#migrating-between-serialization-versions)

* fix broken links by essweine in https://github.com/sartography/SpiffWorkflow/pull/173
* Enhancement/167 drop the pickles by essweine in https://github.com/sartography/SpiffWorkflow/pull/174
* Bug/serializer call activity issue by danfunk in https://github.com/sartography/SpiffWorkflow/pull/179
* refactor: move TaskState object out of Task object by a358003542 in https://github.com/sartography/SpiffWorkflow/pull/178
* Enhancement/improve subprocess serialization by danfunk in https://github.com/sartography/SpiffWorkflow/pull/181

New Contributors
* a358003542 made their first contribution in https://github.com/sartography/SpiffWorkflow/pull/178

**Full Changelog**: https://github.com/sartography/SpiffWorkflow/compare/v1.1.6...v1.1.7

This is just a very quick release to fix an issue with 1.1.5 that could prevent people from deserializing their existing workflows.

What's Changed
* Error deserializing with v1.1.5 by danfunk in https://github.com/sartography/SpiffWorkflow/pull/172
**Full Changelog**: https://github.com/sartography/SpiffWorkflow/compare/v1.1.5...v1.1.6