spiff-arena/README.rst

90 lines
2.1 KiB
ReStructuredText
Raw Normal View History

Spiffworkflow Backend
==========
Squashed 'spiffworkflow-backend/' changes from 55f5c8113..52fad891c 52fad891c update spiff 3e21b7e2e Support reporting on task data (#47) 915fde676 Merge pull request #43 from sartography/send_filters 5c4e633bb Searching for call activities seems to be working now. I had the clear_caches in the wrong place previously - fixing. fa4c8cfbf Pre-pr cleanup 59c71401d Get ./bin/pyl to pass 66e8ad455 Fix status not being a list 62da25810 Add flag to indicate if user filtered 5cb7dce9d It's good to clear out he cache, but we can't do that with correlation properties due to foreign key constraints that are built up over time. So we'll just leave bad messages and correlations in the database for now -- we aren't doing a lot with messages yet anyway. 55020ed38 Merge branch 'main' of github.com:sartography/spiff-arena into send_filters 3334c7f9d update spiff 93526b03e pyl w/ burnettk cullerton 073ffb2ad added development permission for test user w/ burnettk cullerton 53a3f4c97 added some permissions for tasks 7415710d5 fixed broken test w/ burnettk f648f3999 pyl w/ burnettk b7ee3d24b added some permissions to the process model show page w/ burnettk a77ee31b4 Merge pull request #39 from sartography/feature/call_activity_selection 324f58d3f need to filter on process here, or a DMN with the same name will obscure the BPMN. 4ed558470 use id_for_file_path when using the process model id as a path for windows and added some more permission stuff to the frontend w/ burnettk 5d06af147 Assure changes to process ids are updated in the cache on a file save, and remove old references that no longer exist. Still some work to do here. 320a9c41a Getting ./bin/pyl to pass 51f02b20c Send filters back to client 167021e23 filters to_dict ec68bcb24 Merge pull request #38 from sartography/feature/call_activity_selection 71b4f65b9 pyl 866c3699e Merge process_instance_list query filters with report filters (#37) ed9936bfe Fixing a bug in SpiffWorkflow (new version in poetry.lock) fixing a test 89c17b7aa Fixing a bug in SpiffWorkflow (new version in poetry.lock) Don't explode when back-filling process models and hitting and error Assure processes are executable when setting them as the default primary process. The SpecReferenceCache now uses a unique constraint across two fields. (requires a new db) 18f45e90f added permission service to frontend to allow checking for permissions w/ burnettk bd37cfefa added configuration nav item to help reduce nav items w/ burnettk 5fcc6fc87 fix mypy typing stuff. w/ jasquat 5008626b1 run_pyl a3dcae016 Merge remote-tracking branch 'origin/main' into feature/call_activity_selection 2df8dd32d A little quick code cleanup. 58b702fa6 Adding a very simple api endpoint that just returns a list of every process known to the system. a2a0ccac2 Assure that the list of cached Spec References includes all Process Instances and DMNs (even those that are not primary) 5dcdc225a fixed failing tests w/ burnettk c121361d7 more refactoring for process instance list w/ burnettk 9bfb0f9e8 refactored pagination table to allow prefixing page options w/ burnettk b03d531ab Mostly a name change from BpmnProcessIdLookup to SpecReferenceCache. I landed on this unfortunate name because: f7698c0ed use the same file path method in spec file service w/ burnettk 2482827c4 some fixes for windows and python 3.9 w/ burnettk 822c40525 merged in main and resolved pyl issues w/ burnettk 1cdf2af95 Merge remote-tracking branch 'origin/main' into feature/task_page 66b994efd added remaining task tables w/ burnettk b7b6a97df work in spiff is approved and merged, updating dependency 37d9f7cc6 pyl w/ burnettk d96aaa846 added message correlations to message instance list api call w/ burnettk 828e41c4d Adding a display name to the BPMN Process ID Lookup Table Removing (very nearly, except for script unit tests) all the XML Parsing we were doing, see related PR on SpiffWorkflow Moved the Custom Parser into its own file to solve some circular import issues 53d5a7b44 Merge branch 'main' into feature/call_activity_selection 5161fb6e7 Merge branch 'main' of github.com:sartography/spiff-arena into main a2a203e8c add a search button to the call activity to allow finding a process id through some sort of admin interface. 430c03a58 noop, testing pre-commit hook. git-subtree-dir: spiffworkflow-backend git-subtree-split: 52fad891c58132ec8b64f56ac814409bb9e4ea4f
2022-11-21 00:48:30 +00:00
|Tests| |Codecov| |pre-commit| |Black|
.. |Tests| image:: https://github.com/sartography/spiffworkflow-backend/workflows/Tests/badge.svg
:target: https://github.com/sartography/spiffworkflow-backend/actions?workflow=Tests
:alt: Tests
.. |Codecov| image:: https://codecov.io/gh/sartography/spiffworkflow-backend/branch/main/graph/badge.svg
:target: https://codecov.io/gh/sartography/spiffworkflow-backend
:alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
Features
--------
* Backend API portion of the spiffworkflow engine webapp
Running Locally
---------------
* Install libraries using poetry:
.. code:: console
$ poetry install
* Setup the database - uses mysql and assumes server is running by default:
.. code:: console
$ ./bin/recreate_db clean
* Run the server:
.. code:: console
$ ./bin/run_server_locally
Requirements
------------
* Python 3.9+
* Poetry
Contributing
------------
Contributions are very welcome.
To learn more, see the `Contributor Guide`_.
License
-------
Distributed under the terms of the `MIT license`_,
*Spiffworkflow Backend* is free and open source software.
Issues
------
If you encounter any problems,
please `file an issue`_ along with a detailed description.
Credits
-------
This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/sartography/spiffworkflow-backend/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://spiffworkflow-backend.readthedocs.io/en/latest/usage.html