103 lines
2.8 KiB
ReStructuredText
103 lines
2.8 KiB
ReStructuredText
|
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
|