Metadata-Version: 2.1
Name: Flask-Beet
Version: 0.0.2
Summary: A flask extension that allows login via Beet app
Home-page: http://bitshares.eu/
Author: Fabian Schuh
Author-email: fabian@chainsquad.com
License: MIT
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: bitshares
Requires-Dist: Flask
Requires-Dist: Flask-Login
Requires-Dist: Flask-Security
Requires-Dist: Flask-Session
Requires-Dist: SQLAlchemy
Requires-Dist: WTForms
Requires-Dist: Werkzeug
Requires-Dist: uuid
Requires-Dist: blinker

# Flask-Beet Extension

[![build status](https://secure.travis-ci.org/blockchainprojects/flask_beet.png?branch=master)](https://travis-ci.org/#!/blockchainprojects/flask_beet)
[![codecov](https://codecov.io/gh/blockchainprojects/flask_beet/branch/master/graph/badge.svg)](https://codecov.io/gh/blockchainprojects/flask_beet)

Flask-beet is a Flask extension for allow login (flask-security/flask-login)
via signed messages and the [Beet app](http://get-beet.io).

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:

```python
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:

```python
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](http://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.


