sartography
/
spiffworkflow-backend
mirror of https://github.com/sartography/spiffworkflow-backend.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
719 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
burnettk 4efe56f46f improve ScriptUnitTestRunner API and tests 2022-09-19 18:38:21 -04:00
.github Bump poetry from 1.1.15 to 1.2.1 in /.github/workflows 2022-09-16 20:46:46 +00:00
bin Test for environment variable correctly 2022-09-19 13:02:30 -04:00
docs Bump furo from 2022.6.21 to 2022.9.15 in /docs 2022-09-15 20:55:48 +00:00
log added logging for sql and some other updates w/ burnettk 2022-06-21 12:38:04 -04:00
migrations Merge branch 'main' of github.com:sartography/spiffworkflow-backend 2022-09-19 09:03:13 -04:00
src/spiffworkflow_backend improve ScriptUnitTestRunner API and tests 2022-09-19 18:38:21 -04:00
tests improve ScriptUnitTestRunner API and tests 2022-09-19 18:38:21 -04: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 the secrets files for now w/ burnettk 2022-09-15 09:27:58 -04:00
.pre-commit-config.yaml ran precommit and ignoring html files with prettier since it has a hard time with jinja files w/ burnettk 2022-06-02 10:17:53 -04:00
.readthedocs.yml initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.tool-versions initial commit w/ burnettk 2022-05-13 13:42:42 -04: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 added ability to build and run with docker w/ burnettk 2022-06-01 14:50:44 -04:00
LICENSE.rst initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
README.rst clean 2022-09-16 14:51:41 -04:00
codecov.yml initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
conftest.py added method to get data for a process instance in its current state w/ burnettk cullerton 2022-08-26 16:52:15 -04:00
docker-compose.yml some cleanup on code review w/ burnettk cullerton 2022-08-23 12:34:13 -04:00
noxfile.py add stubs to try to get mypy plugin sqlmypy 2022-06-21 22:43:37 -04:00
poetry.lock update spiffworkflow w/ burnettk cullerton 2022-09-13 13:42:43 -04:00
pyproject.toml switched spiffworkflow back to main 2022-09-09 09:56:54 -04:00
sonar-project.properties drop support for python 3.8 2022-06-21 22:34:27 -04:00
wsgi.py support json files for forms and default to running the server locally to using not wsgi w/ burnettk 2022-06-27 16:59:59 -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 - currently requires mysql:

.. 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