SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
Go to file
jasquat 23f0b12e9a Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428
64ac70428 Move to Python 3.11 (#27)
167851df1 remove leading slash from model identifiers
3503fe400 one instance test left for cypress w/ burnettk
7e09363c4 merged in main and resolved conflicts w/ burnettk cullerton
afbc3157d fixed some acceptance tests w/ burnettk cullerton
96e7b63c6 made a process model form w/ burnettk
c19aac25f Somethings up w/authentication. Maybe the stored token is bad
d17007eaa Merge branch 'main' into feature/nested-groups
729b13881 script to modify all model json files to use full path for model id. Also removes process_group_id
7856b8caa return next task when running an instance w/ burnettk
d183b961c First pass at custom report/perspective for Process Instance List (#23)
f303c0f77 remove process_group_identifier from process-instances endpoint
207de9ab8 Merge branch 'main' into feature/nested-groups
fec8d06b8 started test for test_script_unit_test_run
ea31c7a12 fixed process_model_identifier in script_unit_test_create
5d058cbea Fix url in test
f8afd7bdd Remove the `_2` methods
7c13ec802 Fix urls for uspend and resume endpoints
19158d7b0 Get testing bpmn files out of the config directory
5f1ee7f16 fixed failing test
de3b4b81d Merge branch 'main' into feature/nested-groups
440871d57 First stab at nested folders. Added temp endpoints Changes to tests and test helpers
1bd6a199f Don't need parent. Just use the whole path for the group id
a2ab420b2 Committing so Jon can view code

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 64ac7042887af80869963bc103c01f56404727f2
2022-11-09 15:02:19 -05:00
.github Squashed 'spiffworkflow-backend/' changes from 797c99a76..e013fc5da 2022-10-21 17:28:37 -04:00
bin Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
docs Squashed 'spiffworkflow-backend/' changes from 13855180..945b3c0d 2022-10-24 10:44:38 -04:00
keycloak Squashed 'spiffworkflow-backend/' changes from 0de4c06d0..4d7e5e531 2022-10-27 22:03:49 -04:00
log Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
migrations Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
src/spiffworkflow_backend Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
tests Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
.cookiecutter.json Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.darglint Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.flake8 Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.gitattributes Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.gitignore Squashed 'spiffworkflow-backend/' changes from 22766521..b978f502 2022-10-21 16:28:09 -04:00
.pre-commit-config.yaml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.readthedocs.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.tool-versions Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
CODE_OF_CONDUCT.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
CONTRIBUTING.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
Dockerfile Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
LICENSE.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
README.rst Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11 2022-10-25 16:54:06 -04:00
codecov.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
conftest.py Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
docker-compose.yml Squashed 'spiffworkflow-backend/' changes from 1092ed111..ab9b5f368 2022-10-25 16:55:11 -04:00
noxfile.py Squashed 'spiffworkflow-backend/' changes from 5225a8b4..1e831706 2022-10-21 10:36:41 -04:00
poetry.lock Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
pyproject.toml Squashed 'spiffworkflow-backend/' changes from b8924100d..64ac70428 2022-11-09 15:02:19 -05:00
sonar-project.properties Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
wsgi.py Squashed 'spiffworkflow-backend/' changes from eb89e9529..59e6ee2c8 2022-10-13 20:45:04 -04:00

README.rst

Spiffworkflow Backend
==========

|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

(test)