sartography
/
spiffworkflow-backend
mirror of https://github.com/sartography/spiffworkflow-backend.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
39 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
jasquat c5a57a7c65 find out where we are in ci 2022-05-20 13:42:28 -04:00
.github find out where we are in ci 2022-05-20 13:42:28 -04:00
bin attempt to run migrations in ci 2022-05-20 13:40:28 -04:00
docs initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
src/spiff_workflow_webapp pass db type to typeguard w/ burnettk 2022-05-20 11:55:09 -04:00
tests added configs w/ burnettk 2022-05-19 14:38:47 -04:00
.cookiecutter.json initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.darglint initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.flake8 initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.gitattributes initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
.gitignore added some annotations using monkeytype w/ burnettk 2022-05-18 10:49:20 -04:00
.pre-commit-config.yaml initial commit w/ burnettk 2022-05-13 13:42:42 -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 initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
LICENSE.rst initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
README.rst initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
codecov.yml initial commit w/ burnettk 2022-05-13 13:42:42 -04:00
conftest.py pass db type to typeguard w/ burnettk 2022-05-20 11:55:09 -04:00
noxfile.py remove possibly unnecessary var set for typeguard w/ burnettk 2022-05-20 12:00:43 -04:00
poetry.lock added typing_extensions w/ burnettk 2022-05-19 09:33:19 -04:00
pyproject.toml added typing_extensions w/ burnettk 2022-05-19 09:33:19 -04:00
sonar-project.properties initial commit w/ burnettk 2022-05-13 13:42:42 -04:00

README.rst 

Spiff Workflow Webapp
==========

|PyPI| |Status| |Python Version| |License|

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/spiff-workflow-webapp.svg
   :target: https://pypi.org/project/spiff-workflow-webapp/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/spiff-workflow-webapp.svg
   :target: https://pypi.org/project/spiff-workflow-webapp/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/spiff-workflow-webapp
   :target: https://pypi.org/project/spiff-workflow-webapp
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/spiff-workflow-webapp
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/spiff-workflow-webapp/latest.svg?label=Read%20the%20Docs
   :target: https://spiff-workflow-webapp.readthedocs.io/
   :alt: Read the documentation at https://spiff-workflow-webapp.readthedocs.io/
.. |Tests| image:: https://github.com/sartography/spiff-workflow-webapp/workflows/Tests/badge.svg
   :target: https://github.com/sartography/spiff-workflow-webapp/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/sartography/spiff-workflow-webapp/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/sartography/spiff-workflow-webapp
   :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
--------

* TODO


Requirements
------------

* Python 3.7+


Installation
------------

You can install *Spiff Workflow Webapp* via pip_ from PyPI_:

.. code:: console

   $ pip install spiff-workflow-webapp


Usage
-----

Please see the `Command-line Reference <Usage_>`_ for details.


Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_.


License
-------

Distributed under the terms of the `MIT license`_,
*Spiff Workflow Webapp* 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/spiff-workflow-webapp/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://spiff-workflow-webapp.readthedocs.io/en/latest/usage.html