spiff-arena/spiffworkflow-backend
jasquat 3e4fc1259f updated configs to use the prefix using the script w/ burnettk 2023-02-15 17:07:12 -05:00
..
.github catch up with environment change 2023-02-08 12:51:48 -05:00
bin updated configs to use the prefix using the script w/ burnettk 2023-02-15 17:07:12 -05:00
docs Merge commit '70480e9f91a1053531ea5db32a13a791c39fd89f' 2022-10-24 10:44:38 -04:00
keycloak updates to user import scripts w/ burnettk 2023-02-14 17:39:42 -05:00
log Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
migrations tasks and subprocesses can are setting the task states properly now when getting task data w/ burnettk jbirddog 2023-02-09 15:29:45 -05:00
src/spiffworkflow_backend updated configs to use the prefix using the script w/ burnettk 2023-02-15 17:07:12 -05:00
tests The End Event has a spiff step 2023-02-13 14:13:34 -05: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 renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 15:02:47 -05: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 avoid poetry installing deps when we have them cached if they do not change 2023-02-01 07:53:35 -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 renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 15:02:47 -05:00
docker-compose.yml updated configs to use the prefix using the script w/ burnettk 2023-02-15 17:07:12 -05:00
noxfile.py renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 15:02:47 -05:00
poetry.lock Update Spiffworkflow so we have the better error messages on service tasks. 2023-02-12 16:19:40 -05:00
pyproject.toml removed old pin to spiffworkflow w/ burnettk 2023-01-27 13:21:39 -05: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