README.rst

Flask-SQLAlchemy

Flask-SQLAlchemy is an extension for Flask that adds support for SQLAlchemy to your application. It aims to simplify using SQLAlchemy with Flask by providing useful defaults and extra helpers that make it easier to accomplish common tasks.

Installing

Install and update using pip:

$ pip install -U Flask-SQLAlchemy

A Simple Example

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///example.sqlite"
db = SQLAlchemy(app)


class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String, unique=True, nullable=False)
    email = db.Column(db.String, unique=True, nullable=False)


db.session.add(User(username="Flask", email="example@example.com"))
db.session.commit()

users = User.query.all()

Links

• Documentation: https://flask-sqlalchemy.palletsprojects.com/
• Releases: https://pypi.org/project/Flask-SQLAlchemy/
• Code: https://github.com/pallets/flask-sqlalchemy
• Issue tracker: https://github.com/pallets/flask-sqlalchemy/issues
• Test status: https://travis-ci.org/pallets/flask-sqlalchemy
• Test coverage: https://codecov.io/gh/pallets/flask-sqlalchemy