Flask-Beet Extension

Flask-beet is a Flask extension for allow login (flask-security/flask-login) via signed messages and the Beet app.

The login requires a unique string to be signed and submitted. The signature is created with the memo key of an account on the BitShares Blockchain,

Installation

Install the extension with one of the following commands:

$ pip install flask_beet

Usage

Using Flask-Beet is fairly straightforward. Begin by importing the extension and then passing your application object back to the extension, like this:

from flask import Flask
from flask_beet import Beet
app = Flask(__name__)
beet = Beet(app)

You'll also need to extend your user model with the BeetMixin mixin:

from flask_beet import BeetMixin

# Replace
-class User(db.Model, UserMixin):

# with
+class User(db.Model, UserMixin, BeetMixin):

Documentation

The Sphinx-compiled documentation is available here: flask-beet.rtfd.io

Development

This tool uses semversioner to track changes. After changes, please use

semversioner add-change --type patch --description "Fix security vulnerability with authentication."

to track them.