mirror of
https://github.com/wassname/flask-security.git
synced 2026-06-27 16:10:11 +08:00
Anthony Plunkett
101 lines
2.9 KiB
ReStructuredText
101 lines
2.9 KiB
ReStructuredText
Quick Start
|
|
===========
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
Install requirements:
|
|
|
|
$ mkvirtualenv <your-app-name>
|
|
$ pip install flask-security, flask-sqlalchemy
|
|
|
|
|
|
Basic Application
|
|
-----------------
|
|
|
|
The following code sample illustrates how to get started as quickly as possible
|
|
using SQLAlchemy.::
|
|
|
|
from flask import Flask, render_template
|
|
from flask.ext.sqlalchemy import SQLAlchemy
|
|
from flask.ext.security import Security, SQLAlchemyUserDatastore, \
|
|
UserMixin, RoleMixin
|
|
|
|
# Create app
|
|
app = Flask(__name__)
|
|
app.config['DEBUG'] = True
|
|
app.config['SECRET_KEY'] = 'super-secret'
|
|
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://'
|
|
|
|
# Create database connection object
|
|
db = SQLAlchemy(app)
|
|
|
|
# Define models
|
|
roles_users = db.Table('roles_users',
|
|
db.Column('user_id', db.Integer(), db.ForeignKey('user.id')),
|
|
db.Column('role_id', db.Integer(), db.ForeignKey('role.id')))
|
|
|
|
class Role(db.Model, RoleMixin):
|
|
id = db.Column(db.Integer(), primary_key=True)
|
|
name = db.Column(db.String(80), unique=True)
|
|
description = db.Column(db.String(255))
|
|
|
|
class User(db.Model, UserMixin):
|
|
id = db.Column(db.Integer, primary_key=True)
|
|
email = db.Column(db.String(255), unique=True)
|
|
password = db.Column(db.String(255))
|
|
active = db.Column(db.Boolean())
|
|
confirmed_at = db.Column(db.DateTime())
|
|
roles = db.relationship('Role', secondary=roles_users,
|
|
backref=db.backref('users', lazy='dynamic'))
|
|
|
|
# Setup Flask-Security
|
|
user_datastore = SQLAlchemyUserDatastore(db, User, Role)
|
|
security = Security(app, user_datastore)
|
|
|
|
# Create a user to test with
|
|
@app.before_first_request
|
|
def create_user():
|
|
db.create_all()
|
|
user_datastore.create_user(email='matt@nobien.net', password='password')
|
|
db.session.commit()
|
|
|
|
# Views
|
|
@app.route('/')
|
|
def home():
|
|
return render_template('index.html')
|
|
|
|
if __name__ == '__main__':
|
|
app.run()
|
|
|
|
Mail Configuration
|
|
------------------
|
|
|
|
Flask-Security integrates with Flask-Mail to handle all email communications
|
|
between user and site, so it's important to configure Flask-Mail with your
|
|
email server details so Flask-Security can talk with Flask-Mail correctly.
|
|
|
|
The following code illustrates a basic setup, which could be added to the
|
|
basic application code in the previous section::
|
|
|
|
# At top of file
|
|
from flask_mail import Mail
|
|
|
|
# After 'Create app'
|
|
app.config['MAIL_SERVER'] = 'smtp.example.com'
|
|
app.config['MAIL_PORT'] = 465
|
|
app.config['MAIL_USE_SSL'] = True
|
|
app.config['MAIL_USERNAME'] = 'username'
|
|
app.config['MAIL_PASSWORD'] = 'password'
|
|
mail = Mail(app)
|
|
|
|
To learn more about the various Flask-Mail settings to configure it to work
|
|
with your particular email server configuration, please see the
|
|
`Flask-Mail documentation <http://packages.python.org/Flask-Mail/>`_
|
|
|
|
|
|
|
|
|
|
|