spiff-arena/spiffworkflow-backend
jbirddog e8d2396b38
Upsearch api (#1259)
* Run partial tests, add sqlite var

* Add upsearch api

* Getting ./bin/pyl to pass

* Getting ./bin/pyl to pass

* Clean up fixtures

* Revert this change

* PR feedback - use actual schema for api.yml

* Hopefully fix the permissions
2024-03-26 07:56:24 -07:00
..
bin async-support-on-message-start (#1173) 2024-03-06 13:43:06 -08: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
migrations fix-human-task-guid-fk (#1260) 2024-03-25 14:32:44 -04:00
src/spiffworkflow_backend Upsearch api (#1259) 2024-03-26 07:56:24 -07:00
tests Upsearch api (#1259) 2024-03-26 07:56:24 -07: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 command to run pydeps 2023-11-29 21:59:17 -05:00
.pre-commit-config.yaml drop python 3.9 and remove unused libs 2023-05-27 18:17:51 -04:00
.readthedocs.yml
.snyk update cryptography 2024-02-01 14:02:49 -05:00
CODE_OF_CONDUCT.rst
Dockerfile Dev Container Tweaks (#1117) 2024-02-28 09:49:45 -05:00
LICENSE.rst
README.rst Docs/pycharm setup (#1169) 2024-03-07 14:40:24 -05:00
codecov.yml
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 do not run the background scheduler in ci for cypress tests 2023-09-08 10:03:36 -04:00
poetry.lock Bpmn unit test from pi (#1262) 2024-03-26 10:14:57 -04:00
pyproject.toml Docs/pycharm setup (#1169) 2024-03-07 14:40:24 -05:00
sonar-project.properties Feature/pin spiff in ci (#428) 2023-08-03 11:49:30 -04:00
wsgi.py let ruff sort imports and ditch duplicative pre-commit linters 2023-05-26 20:01:08 -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