Jon Herron 492681e5de Squashed 'spiffworkflow-backend/' changes from 03bf7a61..10c443a2
10c443a2 Merge pull request #130 from sartography/feature/data
71c803aa allow passing in the log level into the app w/ burnettk
daeb82d9 Merge pull request #126 from sartography/dependabot/pip/typing-extensions-4.4.0
14c8f52c Merge pull request #123 from sartography/dependabot/pip/dot-github/workflows/poetry-1.2.2
92d204e6 Merge remote-tracking branch 'origin/main' into feature/data
1cb77901 run the save all bpmn script on server boot w/ burnettk
16a6f476 Bump typing-extensions from 4.3.0 to 4.4.0
d8ac61fc Bump poetry from 1.2.1 to 1.2.2 in /.github/workflows
3be27786 Merge pull request #131 from sartography/feature/permissions2
1fd8fc78 Merge remote-tracking branch 'origin/main' into feature/permissions2
d29621ae data setup on app boot
0b21a5d4 refactor bin/save_all_bpmn.py into service code
02fb9d61 lint
c95db461 refactor scripts
98628fc2 This caused a problem with scopes when token timed out.
d8b2323b merged in main and resolved conflicts
d01b4fc7 updated sentry-sdk to resolve deprecation warnings
5851ddf5 update for mypy in python 3.9
508f9900 merged in main and resolved conflicts
68d69978 precommit w/ burnettk
85a4ee16 removed debug print statements w/ burnettk
93eb91f4 added keycloak configs and user perms for staging w/ burnettk
e4ded8fc added method to import permissions from yml file w/ burnettk
22ba89ae use percents instead of asterisks to better support db syntax w/ burnettk
0c116ae8 postgres does not use backticks w/ burnettk
621ad3ef attempting to see if sql like statement works in other dbs as well w/ burnettk

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 10c443a2d82752e8ed9d1679afe6409d81029006
2022-10-12 15:28:52 -04: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 71.7%
TypeScript 17.2%
JavaScript 7.3%
Shell 2.4%
CSS 0.7%
Other 0.6%