spiff-arena/spiffworkflow-backend
Dan 4a8b07e98d Removing two fields from user table that were not used (uid, name)
Request email from open id clients, as this would provide a handy way to uniquely reference users when assigning to groups.
During Login do a lookup on email if possible -- so that permissions assignments based on email can be connected when sigining in through openid.
Don't use "open_id" for the service name on user accounts, use the iss string provided through open id,  this will allow us to support more than one open id platform.
Update the KeyCloak configuration so it is able to return email addresses for users -- which will make permission assignment easier in the future.
Removed several unused commands in the user_service class.
2022-12-12 15:43:19 -05:00
..
.github bump nox stuff and spiff 2022-12-05 09:08:56 -05:00
bin Removing two fields from user table that were not used (uid, name) 2022-12-12 15:43:19 -05:00
docs Merge commit '70480e9f91a1053531ea5db32a13a791c39fd89f' 2022-10-24 10:44:38 -04:00
keycloak upgrade keycloak 2022-11-27 21:17:07 -05:00
log Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
migrations Removing two fields from user table that were not used (uid, name) 2022-12-12 15:43:19 -05:00
src/spiffworkflow_backend Removing two fields from user table that were not used (uid, name) 2022-12-12 15:43:19 -05:00
tests Removing two fields from user table that were not used (uid, name) 2022-12-12 15:43:19 -05: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 mypy w/ burnettk cullerton 2022-12-08 17:12:19 -05:00
.gitattributes Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.gitignore Merge commit 'f0b608789b6cdc3ef4303efac053746c98571a48' 2022-10-21 16:28:09 -04:00
.pre-commit-config.yaml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.readthedocs.yml Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
.tool-versions oops 2022-11-11 08:22:25 -05:00
CODE_OF_CONDUCT.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
CONTRIBUTING.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
Dockerfile Merge commit '89bfc25f35bdfd57eb9ccf6f3a9a3de76e68cf93' 2022-11-09 15:45:49 -05:00
LICENSE.rst Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -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 Merge commit '883e65384f1e36a0310f4fdcff57ac486890cd5e' as 'spiffworkflow-backend' 2022-10-12 10:22:22 -04:00
conftest.py pyl passes 2022-12-08 13:47:30 -05:00
docker-compose.yml pass in perm file for acceptance tests w/ burnettk 2022-11-09 17:30:33 -05:00
noxfile.py Merge commit 'de30945eec9161570080b4858da967a7628ec86c' 2022-11-09 15:44:08 -05:00
poetry.lock bump nox stuff and spiff 2022-12-05 09:08:56 -05:00
pyproject.toml upgrade apscheduler and fix mispelling 2022-11-21 21:15:48 -05:00
sonar-project.properties Merge commit 'de30945eec9161570080b4858da967a7628ec86c' 2022-11-09 15:44:08 -05:00
wsgi.py Merge commit '93dbce681ec89bc45479748aaae06ddd92b64da4' 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