https://github.com/emersonelectricco/lowball

Lowball is designed to add simple endpoint level RBAC to your Flask based API services.
https://github.com/emersonelectricco/lowball

flask microservice python restful-api

Last synced: 2 months ago
JSON representation

Lowball is designed to add simple endpoint level RBAC to your Flask based API services.

• Host: GitHub
• URL: https://github.com/emersonelectricco/lowball
• Owner: EmersonElectricCo
• License: apache-2.0
• Created: 2021-02-16T19:58:42.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-02T21:01:22.000Z (over 3 years ago)
• Last Synced: 2024-10-11T16:11:24.776Z (3 months ago)
• Topics: flask, microservice, python, restful-api
• Language: Python
• Homepage:
• Size: 113 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Lowball



Lowball is designed to add simple endpoint level RBAC to your Flask based API services.



## Overview

Lowball is, at its core, a wrapper around Flask, designed to add authentication

and permission management features to Flask's already powerful and modular implementation. Lowball was developed to

support three key needs:

1) Easy to use route level RBAC controls.

2) Abstracted authentication providers and databases for easier integration with your operating environment.

3) Ecosystem of 1 - n microservices leveraging a common authentication authority.

## Installation

### Using pip

`pip install lowball`

### From Source

```shell

git clone https://github.com/EmersonElectricCo/lowball

cd ./lowball

pip install -r requirements.txt

python3 setup.py install

```

## A Simple Example

A minimal lowball service looks like this

```python

from lowball import Lowball, require_admin

app = Lowball()

@app.route("/hello", methods=["GET"])

@require_admin

def hello_world():

    return {"hello":"world"}, 200

if __name__ == '__main__':

    app.run()

```

Check [docs](https://lowball.readthedocs.io/en/stable/) for more in-depth explanations of components.

## Links

- [Issues](https://github.com/EmersonElectricCo/lowball/issues)