jasquat 7b85be037b Squashed 'spiffworkflow-backend/' changes from ecbe9704..7600e1e5
7600e1e5 added new api endpoint to get task-info so users with access to process instances can see the tasks but not the data
643f632c fix permissions for core on dev w/ burnettk
78badf26 fix broken unit tests in backend
6a9272b3 do not set git branch info on development w/ burnettk cullerton
e5b03110 commit and push to github on all changes to bpmn dir w/ burnettk cullerton
e33d0030 Merge branch 'main' of github.com:sartography/spiff-arena
cf9b2fcb add support to find the form for a call activity defined in another process model
494a427c Fix endpoints for script task unit tests (#77)
6eec41a7 make replacing keycloak more robust, as it now works when the container is running
ec01b279 some fixes for ci w/ burnettk
7e520dbc remove assert statements from actual code w/ burnettk
511d31b9 fixed perms for readonly for staging w/ burnettk
900f4524 load the correct perm file on staging w/ burnettk
562ec8ef added permission file for staging w/ burnettk
7e39994c in postgres you cannot order by a non-grouped column without doing an aggregate
36c50953 pyl and fix test w/ burnettk
f15794a2 store subprocesses for spiff steps as well and do not save file as primary if one is already set w/ burnettk
395b7e44 Merge remote-tracking branch 'origin/main' into feature/view_call_activity_diagram
4c119caa some fixes to ensure we display the correct task data for the diagram elements w/ burnettk
ebbb593e lint
6ae471d0 pyl
5e54256a added test to get the diagram for a given process instance call activity
2c1d8b62 allow viewing the diagram for a specific process identifier
b8a5690c strip off spaces from git service command stdout
1291c8d4 try to fix a test on windows

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 7600e1e57917b3a1b3d07d41daaeddbb09e8242c
2022-12-16 13:23:57 -05:00

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
Description
SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams
https://www.spiffworkflow.org/
Readme LGPL-2.1
Languages
Python 61.9%
TypeScript 32.3%
Shell 2.9%
JavaScript 1.1%
CSS 1%
Other 0.8%