SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
Go to file
Dan c5a2f8b16c Squashed 'spiffworkflow-backend/' changes from 106b5d75b..227665212
227665212 Merge pull request #147 from sartography/feature/improve_connector_proxy_calls
306618d99 Send a json request to the connector proxy (don't send a set of post params, as these will all be converted to strings) Requires changes on the connector proxy as well. Adding SimpleJson as a dependency -- when it is available, Flask will prefer its use when serializing requests - and this will avoid errors when attempting to send decimal values.  As I understand it, using SimpleJson on both ends will assure that decimals are represented as strings during serialization, but SimpleJson will know to deserialize them back to decimals on the other side. Can't say I'm lovin on Json at the moment.

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 227665212e28f5d48e2fc03ceb92a8805ae43f0a
2022-10-21 16:18:25 -04:00
.github Squashed 'spiffworkflow-backend/' changes from eb89e9529..59e6ee2c8 2022-10-13 20:45:04 -04:00
bin Squashed 'spiffworkflow-backend/' changes from 5225a8b4..1e831706 2022-10-21 10:36:41 -04:00
docs Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
keycloak Squashed 'spiffworkflow-backend/' changes from 1965bfe2d..823e32eb8 2022-10-17 21:35:30 -04:00
log Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
migrations Squashed 'spiffworkflow-backend/' changes from 5225a8b4..1e831706 2022-10-21 10:36:41 -04:00
src/spiffworkflow_backend Squashed 'spiffworkflow-backend/' changes from 106b5d75b..227665212 2022-10-21 16:18:25 -04:00
tests Squashed 'spiffworkflow-backend/' changes from 5225a8b4..1e831706 2022-10-21 10:36:41 -04: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/' content from commit 50f28073 2022-10-12 10:22:22 -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/' content from commit 50f28073 2022-10-12 10:22:22 -04: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/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
LICENSE.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
README.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -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 f9c2fa21e..5225a8b4c 2022-10-20 16:00:12 -04:00
docker-compose.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -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 106b5d75b..227665212 2022-10-21 16:18:25 -04:00
pyproject.toml Squashed 'spiffworkflow-backend/' changes from 106b5d75b..227665212 2022-10-21 16:18:25 -04: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