flask-ligand 0.2.0

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

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

Developer Quick Start Guide

Follow the instructions below to get a development environment up and running quickly!

Prerequisites

• Python 3.10+

• virtualenvwrapper

• Docker

Getting Help with Make Tasks

Execute the following command to get a full list of make targets:

$ make help

Setup Python Development Environment

1. Create a Python virtual environment:

   $ mkvirtualenv -p py310 flask-ligand

2. Setup develop environment:

   $ make develop-venv

3. Setup git pre-commit hooks:

   $ make setup-pre-commit

4. Verify that environment is ready for development:

   $ make test-tox

Configuration Settings

The following environment variables are available to configure behavior of services that use this library when utilizing the built-in ‘local’ and ‘dev’ and ‘prod’ Flask environments. (See flask_environments.rst for more details about the available built-in Flask environments)

(Note: this project does support the use of ‘.env’ files for loading environment variables)

Environment Variable Settings

ENV	Default Value for ‘local’ Flask Environment	Description
SERVICE_PUBLIC_URL	http://localhost:5000	The public URL for this service. (Also used for generating OpenAPI clients)
SERVICE_PRIVATE_URL	http://localhost:5000	The private URL for this service. (Also used for generating OpenAPI clients)
ALLOWED_ROLES	user,admin	A comma separated list of user roles that are allowed for endpoint protection. (e.g. ‘user,admin’)
OIDC_ISSUER_URL	Not set (must be provided)	The OpenID Connect IAM URL to use for authentication.
OIDC_REALM	Not set (must be provided)	The OpenID Connect IAM realm to use for authentication.
SQLALCHEMY_DATABASE_URI	sqlite:///:memory:	The URI for a PostgreSQL database to use for persistent storage. (See database_configuration.rst for more information)
OPENAPI_GEN_SERVER_URL	http://api.openapi-generator.tech	The OpenAPI online generator server URL to use for creating clients.

Integration Testing

See integration_testing.rst for more details on how to setup and run the integration tests for the flask-ligand project.

Contributing

See CONTRIBUTING.rst for more details on developing for the flask-ligand project.

Release Process

See release_process.rst for information on the release process for the flask-ligand project.

Python Black IDE Integration

This repo utilizes Python Black for automatic code formatting using the make format task. However, this is not very convenient to use on a regular basis and instead it is recommended to integrate Python Black into your IDE workflow. Checkout these editor integration guides for integrating Python Black with popular IDEs and text editors.