SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
Go to file
burnettk bf48f91a2f Squashed 'flask-bpmn/' changes from a901d7ffb..cedc5253a
cedc5253a Merge pull request #8 from sartography/feature/clean_up_sentry_errors
3f3730226 removed exra comment signs w/ burnettk
e070503f7 avoid sending two errors to sentry w/ burnettk

git-subtree-dir: flask-bpmn
git-subtree-split: cedc5253add81a18a274f2cd3289fe36bb138f8b
2022-10-27 22:03:51 -04:00
.github Squashed 'flask-bpmn/' changes from b79454e50..a8b90f2ca 2022-10-26 13:40:39 -04:00
docs Squashed 'flask-bpmn/' changes from c7e2f98d..aae17b7b 2022-10-24 17:53:04 -04:00
src/flask_bpmn Squashed 'flask-bpmn/' changes from a901d7ffb..cedc5253a 2022-10-27 22:03:51 -04:00
tests Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.cookiecutter.json Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.darglint Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.flake8 Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.gitattributes Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.gitignore Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.pre-commit-config.yaml Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.readthedocs.yml Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
.tool-versions Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
CODE_OF_CONDUCT.rst Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
CONTRIBUTING.rst Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
LICENSE.rst Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
README.rst Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
codecov.yml Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
noxfile.py Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00
poetry.lock Squashed 'flask-bpmn/' changes from a8b90f2ca..a901d7ffb 2022-10-27 14:57:30 -04:00
pyproject.toml Squashed 'flask-bpmn/' changes from a8b90f2ca..a901d7ffb 2022-10-27 14:57:30 -04:00
sonar-project.properties Squashed 'flask-bpmn/' content from commit f3fc5394 2022-10-12 10:23:45 -04:00

README.rst

Flask Bpmn
==========

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

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

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

* Provides bmpn engine functionality for inclusion in a flask application.


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

* Python 3.7+


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

You can install *Flask Bpmn* via pip_ from PyPI_:

.. code:: console

   $ pip install flask-bpmn


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`_,
*Flask Bpmn* 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/flask-bpmn/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://flask-bpmn.readthedocs.io/en/latest/usage.html