sartography
/
spiffworkflow-backend
mirror of https://github.com/sartography/spiffworkflow-backend.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,088 Commits 26 Branches 0 Tags 5.1 MiB
Python 95.4%
Shell 3.9%
CSS 0.3%
Dockerfile 0.2%
HTML 0.2%
Go to file
Dan adfb0644f5 Adding Migration. 2023-02-23 14:42:00 -05:00
.github catch up with environment change 2023-02-08 12:51:48 -05:00
bin set git user configs explicitly using the env vars w/ burnettk 2023-02-22 15:34:47 -05:00
docs Bump sphinx from 5.2.3 to 5.3.0 in /docs 2022-10-21 22:14:57 +00:00
keycloak put the env vars in the env section of the github action configs w/ burnettk 2023-02-16 15:19:01 -05:00
log added logging for sql and some other updates w/ burnettk 2022-06-21 12:38:04 -04:00
migrations Adding Migration. 2023-02-23 14:42:00 -05:00
src/spiffworkflow_backend Merge remote-tracking branch 'origin/main' into feature/message_fixes 2023-02-23 14:26:04 -05:00
tests Merge remote-tracking branch 'origin/main' into feature/message_fixes 2023-02-23 14:26:04 -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 renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 15:02:47 -05:00
.gitattributes initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.gitignore link to correct instances page, fix fin users, ignore coverage files 2022-12-23 20:18:08 -05: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 Move to Python 3.11 (#27) 2022-11-09 13:45:16 -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 so we do not lose our minds when debugging on a server 2023-02-22 15:16:13 -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 run_pyl 2023-02-20 12:34:42 -05:00
docker-compose.yml more config updates w/ burnettk 2023-02-16 10:21:02 -05:00
noxfile.py renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 15:02:47 -05:00
poetry.lock BPMN.io -- Just show the message names not the ids - to assure we are only exposing the names. 2023-02-23 13:53:03 -05:00
pyproject.toml * Re-work message tests so I could wrap my simple head around what was happening - just needed an example that made sense to me. 2023-02-18 13:09:58 -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