repository·master·Indexed 26 days ago
https://github.com/dpgaspar/flask-appbuilderA rapid application development framework built on Flask, specializing in automated CRUD generation, robust security/RBAC, and integrated data visualization. Version 1.0.0 includes tools for database migrations, password hashing, and custom action decorators for ModelViews.
Flask App Builder (FAB) is a development framework designed to simplify web application development by adhering to the DRY (Don't repeat yourself) principle. It provides a highly configurable foundation that goes beyond simple admin scaffolding, allowing for custom pages and flows using standard Flask/Jinja2.
Key capabilities include:
REMOTE_USER authentication. It also supports public/private permissions and self-user registration.Flask-AppBuilder (FAB) is a framework designed for simple and rapid application development. It is built on top of Flask and provides several high-level features including:
Flask App Builder's view layer is organized into a hierarchy where each layer handles specific responsibilities. Developers typically interact with BaseViews, IndexViews, and leaf nodes like ModelView, chart views, and form views.
Key view classes include:
BaseView: The foundation that collects exposed methods, creates Flask blueprints, registers URLs, and initializes base permissions.IndexView: A specialized view for rendering the index page.SimpleFormView: A subclass used to render WTForms.PublicFormView: Similar to SimpleFormView but restricted to public access.BaseModelView: Handles the initial data model layer, including search forms and filters.BaseChartView: Provides basic chart functionality.GroupByChartView: A subclass for rendering Google charts using group-by queries.DirectByChartView: A subclass for rendering Google charts with direct queries.BaseCRUDView: Implements core functionality for add, edit, and delete operations, and creates all necessary forms.ModelView: The primary subclass used to render views based on models with full CRUD UI functionality.MasterDetailView: Renders a master ModelView alongside multiple related detail ModelViews.MultipleView: Used to render multiple views on a single page (e.g., a ModelView and a GroupByChartView).Security in Flask App Builder is managed through a hierarchy of Manager classes. These classes are responsible for registering security views, implementing authentication methods, and managing permissions (inserting/removing permissions on the backend).
Security components:
BaseManager: The base class for all Manager classes; it holds the AppBuilder instance.AbstractSecurityManager: An abstract class that defines the required methods for security managers.BaseSecurityManager: The base class for security that registers views, implements authentication, manages roles/users/views, and handles database permission synchronization.sqla.SecurityManager: The SQLAlchemy-specific implementation of BaseSecurityManager.The data access layer is designed to abstract the backend. All data access classes implement a unique API layer via the BaseInterface.
Supported interfaces:
SQLAInterface: Provides data access specifically for SQLAlchemy.GenericInterface: Provides data access for custom data structures.Flask App Builder includes several high-level features for application development:
flask-jwt-extended to protect endpoints.To customize the detail/show page (e.g., to add action buttons to the top of a long page):
appbuilder/general/widgets/show.html. Override specific blocks (like columns) and use {{ super() }} to preserve existing content.flask_appbuilder.widgets.ShowWidget and set the template attribute.show_widget attribute of your ModelView.# 1. The Template: templates/widgets/my_show.html
{% extends "appbuilder/general/widgets/show.html" %}
{% block columns %}
<div class="well well-sm">
{{ lib.render_action_links(actions, pk, modelview_name) }}
{{ lib.lnk_back() }}
</div>
{{ super() }}
{% endblock %}
# 2. The Python Class
from flask_appbuilder.widgets import ShowWidget
class MyShowWidget(ShowWidget):
template = 'widgets/my_show.html'
# 3. The View
class MyModelView(ModelView):
datamodel = SQLAInterface(MyModel)
show_widget = MyShowWidgetThe deprecated RestCRUDView class has been removed. To maintain REST functionality or standard views, inherit from ModelView instead.
# After (v5.x)
from flask_appbuilder import ModelView
class MyView(ModelView):
datamodel = SQLAInterface(MyModel, db.session)In version 0.9.x, the initialization of AppBuilder (formerly BaseApp) changed. You must now pass the SQLAlchemy session object instead of the db object.
# Change from:
BaseApp(app, db)
# To:
AppBuilder(app, db.session)Flask App Builder can use csp_nonce() in Jinja2 templates if Flask-Talisman is installed. However, FAB does not initialize Talisman automatically. You must initialize it manually in your application setup.
from flask import Flask
from flask_appbuilder import AppBuilder, SQLA
from flask_talisman import Talisman
app = Flask(__name__)
app.config.from_object('config')
db = SQLA(app)
appbuilder = AppBuilder(app, db.session)
Talisman(app)