spiff-arena/spiffworkflow-backend
jbirddog 823bdd170b
Allow updating task data via a dictionary (#1414)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-04-17 14:20:51 -04:00
..
bin Look for bad get_current_user scripts (#1370) 2024-04-10 09:44:13 -07:00
docs Fixing line endings on a markdown file. 2024-03-11 14:57:50 -04:00
keycloak added spiffworkflow-2 realm based on spiffworkflow realm w/ burnettk 2023-11-28 12:41:16 -05:00
local_wheels spiff-element-units integration (#214) 2023-04-17 14:49:38 -04:00
log Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
migrations fix-human-task-guid-fk (#1260) 2024-03-25 14:32:44 -04:00
src/spiffworkflow_backend Allow updating task data via a dictionary (#1414) 2024-04-17 14:20:51 -04:00
tests Drop element units as a dependecy (#1366) 2024-04-10 11:22:52 -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 pyl and turn back on autoreload for homepage w/ burnettk 2023-04-13 16:56:49 -04:00
.gitattributes Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.gitignore ignore venv, and ensure always sort group members to fix flaky test in postgres (#1357) 2024-04-08 11:26:07 -07:00
.pre-commit-config.yaml drop python 3.9 and remove unused libs 2023-05-27 18:17:51 -04:00
.readthedocs.yml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.snyk fixed and ignored unfixable synk issues 2024-04-16 10:22:57 -04:00
CODE_OF_CONDUCT.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
Dockerfile Dev Container Tweaks (#1117) 2024-02-28 09:49:45 -05:00
LICENSE.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
README.rst Docs/pycharm setup (#1169) 2024-03-07 14:40:24 -05:00
codecov.yml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
conftest.py Feature/typeahead allow guest user (#897) 2024-01-16 14:47:25 -05:00
dev.Dockerfile Update secrets programmatically (#1122) 2024-02-29 09:55:09 -05:00
dev.docker-compose.yml Fix for first time use of dev containers in clean environment (#1136) 2024-03-01 15:28:06 -05:00
docker-compose.yml Allow setting path prefix (#1344) 2024-04-05 15:14:09 -04:00
poetry.lock updated SpiffWorkflow to deepcopy task data (#1408) 2024-04-17 09:38:03 -04:00
pyproject.toml Drop element units as a dependecy (#1366) 2024-04-10 11:22:52 -04:00
sonar-project.properties Feature/pin spiff in ci (#428) 2023-08-03 11:49:30 -04:00
wsgi.py Bump black from 23.1.0 to 24.3.0 (#1285) 2024-03-27 14:05:49 -04:00

README.rst

Spiffworkflow Backend
==========
|Tests| |Codecov| |pre-commit| |Black|

.. |Tests| image:: https://github.com/sartography/spiff-arena/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/sartography/spiff-arena/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/sartography/spiff-arena/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/sartography/spiff-arena
   :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
---------------

See detailed instructions at the root of spiff-arena, but:

* Install libraries using poetry:

.. code:: console

   $ poetry install

NOTE: Mysql and Postgres may require special binary files exist on your system prior
to installing these libraries. Please see the `PyPi mysqlclient instructions`_
and the pre-requisites for the `Postgres psycopq2 adapter`_ Following the
instructions here carefully will assure your OS has the right dependencies
installed.

* 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.10+
* Poetry


Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_.


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
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/sartography/spiffworkflow-arena/issues
.. github-only
.. _PyPi mysqlclient instructions: https://pypi.org/project/mysqlclient/
.. _Postgres psycopq2 adapter: https://www.psycopg.org/docs/install.html#prerequisites