flask-ligand 0.1.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

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-all

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.