flask-ligand

============ flask-ligand

.. excerpt-start

|docs-status| |build-status| |pypi-status| |codecov-status| |pre-commit-status|

A simple Flask library for building microservices with RBAC JWT security, OpenAPI client and SQLAlchemy database support.

Install

.. code-block:: bash

$ pip install flask-ligand

Why Use this Library?

Using Flask_ to create a REST based microservice is a daunting process which will definitely require the use of many different Flask extensions_ which will really slow down the process of actually writing a functional REST microservice that can be used safely in a production environment. This library seeks to use the best Flask extensions_ loosely combined together to deliver a delightful developer experience by providing the following functionality out-of-the-box:

• Create database models using the industry standard SQLAlchemy ORM_
• Leverage those same database models to create schemas for marshalling data in and out of your Flask_ endpoints defined via Blueprints
• Provide automatic SwaggerUI_ docs for quickly developing and testing your Flask_ application without the need of external tools like curl, Postman or Hoppscotch
• Generate OpenAPI clients_ for a variety of languages
  • Endpoints for generating Python and Typescript clients already included!
• Protect endpoints with JWT security with a OpenID Connect_ IAM like Auth0_ or Keycloak_
  • Optionally control access to endpoints using RBAC_
• Quickly enable pagination_ and ETag_ support for your endpoints
• Easily manage database migrations using Alembic through the fantastic Flask-Migrate_ library and command-line tools

.. _Flask: https://flask.palletsprojects.com/en/2.2.x/ .. _Flask extensions: https://flask.palletsprojects.com/en/2.2.x/extensions/ .. _SQLAlchemy ORM: https://www.sqlalchemy.org/ .. _SwaggerUI: https://swagger.io/tools/swagger-ui/ .. _Generate OpenAPI clients: https://openapi-generator.tech/ .. _Auth0: https://auth0.com/ .. _Keycloak: https://www.keycloak.org/ .. _RBAC: https://en.wikipedia.org/wiki/Role-based_access_control .. _OpenID Connect: https://openid.net/connect/ .. _pagination: https://flask-smorest.readthedocs.io/en/latest/pagination.html .. _ETag: https://flask-smorest.readthedocs.io/en/latest/etag.html .. _Flask-Migrate: https://flask-migrate.readthedocs.io/en/latest/

.. |docs-status| image:: https://img.shields.io/readthedocs/flask-ligand/stable?logo=readthedocs :target: https://flask-ligand.readthedocs.io/en/stable/ :alt: Docs .. |build-status| image:: https://img.shields.io/github/actions/workflow/status/cowofevil/flask-ligand/bump_and_publish_release.yml?branch=main&logo=github :target: https://github.com/cowofevil/flask-ligand/actions/workflows/bump_and_publish_release.yml :alt: Build .. |pypi-status| image:: https://img.shields.io/pypi/v/flask-ligand?color=blue&logo=pypi :target: https://pypi.org/project/flask-ligand/ :alt: PyPI .. |codecov-status| image:: https://img.shields.io/codecov/c/gh/cowofevil/flask-ligand?color=teal&logo=codecov :target: https://app.codecov.io/gh/cowofevil/flask-ligand :alt: Codecov .. |pre-commit-status| 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

.. excerpt-end

Resources

• Documentation_
• Changelog_
• Contributing_
• License_

.. _Documentation: https://flask-ligand.readthedocs.io/en/stable/ .. _Changelog: ./CHANGELOG.md .. _Contributing: ./CONTRIBUTING.rst .. _License: ./LICENSE