spiff-arena/spiffworkflow-backend
burnettk 6bfce59fe3 lint 2023-03-16 22:59:42 -04:00
..
.github use poetry 1.3.2 2023-03-06 14:41:03 -05:00
bin increase line length from 88 to 119 for black w/ burnettk 2023-03-15 16:24:08 -04:00
docs Merge commit '70480e9f91a1053531ea5db32a13a791c39fd89f' 2022-10-24 10:44:38 -04:00
keycloak add list with just one user for bootstrapping 2023-03-14 15:08:10 -04:00
log Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
migrations added bpmn process definition to bpmn process w/ burnettk 2023-03-16 16:59:37 -04:00
src/spiffworkflow_backend lint 2023-03-16 22:59:42 -04:00
tests lint 2023-03-16 22:59:42 -04:00
.cookiecutter.json Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.darglint Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.flake8 our main test is passing w/ burnettk 2023-03-13 13:49:55 -04:00
.gitattributes Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.gitignore link to correct instances page, fix fin users, ignore coverage files 2022-12-23 20:18:08 -05:00
.pre-commit-config.yaml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.readthedocs.yml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.tool-versions oops 2022-11-11 08:22:25 -05:00
CODE_OF_CONDUCT.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
CONTRIBUTING.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
Dockerfile some minor tweaks and turn off debug logging for spiff step details w/ burnettk 2023-03-06 16:16:55 -05:00
LICENSE.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
README.rst add a search button to the call activity to allow finding a process id through some sort of admin interface. 2022-11-11 11:02:29 -05:00
codecov.yml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
conftest.py no op cipher for testing 2023-03-12 18:20:29 -04:00
docker-compose.yml no op cipher for testing 2023-03-12 18:20:29 -04:00
noxfile.py increase line length from 88 to 119 for black w/ burnettk 2023-03-15 16:24:08 -04:00
poetry.lock some more test stuff w/ burnettk 2023-03-16 10:29:15 -04:00
pyproject.toml fix all deprecation warnings 2023-03-16 22:42:35 -04:00
sonar-project.properties Merge commit 'de30945eec9161570080b4858da967a7628ec86c' 2022-11-09 15:44:08 -05:00
wsgi.py Merge commit '93dbce681ec89bc45479748aaae06ddd92b64da4' 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