Go to file
mike cullerton 38dc4570de process group move api endpoint 2022-11-19 13:24:40 -05:00
.github arena github actions 2022-11-12 22:41:43 -05:00
bin pyl is passing w/ burnettk cullerton 2022-11-18 16:45:44 -05:00
docs Bump sphinx from 5.2.3 to 5.3.0 in /docs 2022-10-21 22:14:57 +00:00
keycloak we will set these at runtime 2022-10-27 22:03:32 -04:00
log added logging for sql and some other updates w/ burnettk 2022-06-21 12:38:04 -04:00
migrations precommit 2022-11-18 15:50:20 -05:00
src/spiffworkflow_backend process group move api endpoint 2022-11-19 13:24:40 -05:00
tests process group move api endpoint 2022-11-19 13:24:40 -05:00
.cookiecutter.json updated to use spiffworkflow-backend naming w/ burnettk 2022-06-01 11:17:25 -04:00
.darglint initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.flake8 set process name for api 2022-08-30 18:40:40 -04:00
.gitattributes initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.gitignore ignore all null-ls w/ burnettk 2022-10-21 11:09:28 -04:00
.pre-commit-config.yaml precommit is now passing 2022-10-11 09:53:42 -04:00
.readthedocs.yml initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.tool-versions oops 2022-11-11 08:22:25 -05:00
CODE_OF_CONDUCT.rst initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
CONTRIBUTING.rst drop support for python 3.8 2022-06-21 22:34:27 -04:00
Dockerfile do not install dev dependencies when building docker image w/ burnettk 2022-11-09 15:44:28 -05:00
LICENSE.rst initial commit w/ burnettk 2022-05-13 13:42:42 -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 initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
conftest.py pyl is passing w/ burnettk cullerton 2022-11-18 16:45:44 -05:00
docker-compose.yml pass in perm file for acceptance tests w/ burnettk 2022-11-09 17:30:33 -05:00
noxfile.py add back in support for python 3.9 and favor 3.11 for tests w/ burnettk 2022-11-09 15:15:27 -05:00
poetry.lock update spiff 2022-11-16 13:21:09 -05:00
pyproject.toml Adding a display name to the BPMN Process ID Lookup Table 2022-11-12 12:36:07 -05:00
sonar-project.properties add back in support for python 3.9 and favor 3.11 for tests w/ burnettk 2022-11-09 15:15:27 -05:00
wsgi.py lint 2022-10-13 09:52:47 -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