spiff-arena/spiffworkflow-backend
danfunk aaffd9f014 Adding import 2023-05-10 16:52:02 -04:00
..
.github use poetry 1.3.2 2023-03-06 14:41:03 -05:00
bin Merge remote-tracking branch 'origin/main' into bug/improve_reset_to_previous_task 2023-05-10 10:57:55 -04:00
docs
keycloak added script to add passwords to keycloak user list and moved user lists out of this repo w/ burnettk 2023-04-14 12:09:51 -04:00
local_wheels spiff-element-units integration (#214) 2023-04-17 14:49:38 -04:00
log
migrations updated active user db model w/ burnettk 2023-05-04 12:51:15 -04:00
src/spiffworkflow_backend Adding import 2023-05-10 16:52:02 -04:00
tests Merge remote-tracking branch 'origin/main' into bug/improve_reset_to_previous_task 2023-05-10 16:51:47 -04:00
.cookiecutter.json
.darglint
.flake8 pyl and turn back on autoreload for homepage w/ burnettk 2023-04-13 16:56:49 -04:00
.gitattributes
.gitignore spiff-element-units integration (#214) 2023-04-17 14:49:38 -04:00
.pre-commit-config.yaml
.readthedocs.yml
.snyk ignore issue for which ticket has been filed 2023-05-03 10:49:32 -04:00
.tool-versions
CODE_OF_CONDUCT.rst
CONTRIBUTING.rst
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
README.rst
codecov.yml
conftest.py updated typeguard and fixed issues w/ burnettk 2023-05-01 15:26: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 updated spiffworkflow w/ burnettk 2023-05-10 16:43:08 -04:00
pyproject.toml run_pyl 2023-05-10 15:42:07 -04:00
sonar-project.properties
wsgi.py make this thing a config and clean up lint 2023-05-01 11:25:37 -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