Flask-AppBuilder
v3.4.0
Introduction
Installation
Using pip
Initialization
Installation Requirements
Python 2 and 3 Compatibility
Command Line Manager
create-app
- Create new Applications
create-admin
- Create an admin user
babel-extract
- Babel, Extracts and updates all messages.
create-addon
- Create new AddOns
collect-static
- Collect static files
upgrade-db
- Upgrade your database after F.A.B. upgrade to 1.3.0
reset-password
- Resets a user’s password.
Base Configuration
Configuration keys
Using config.py
Using JMESPath to map user registration role
Base Views
BaseView
Form Views
Model Views (Quick How to)
The Base Skeleton Application
Simple contacts application
Define your models (models.py)
Define your Views (views.py)
Register (views.py)
Security
Example and Live Demo
Exposed methods
REST API
URL=/api
URL=/api/read
URL=/api/delete/<PK>
Extra Views
REST API
OpenAPI spec
Security
Model REST API
Information endpoint
Get Item
Lists and Queries
Updates and Partial Updates
Validation and Custom Validation
Many to Many relations
Pre and Post processing
Excluding builtin generated routes
Enum Fields
Model Views on MongoDB
Initialization
Define your models (models.py)
Define your Views (views.py)
Register (views.py)
Chart Views
Direct Data Charts
Grouped Data Charts
(Deprecated) Define your Chart Views (views.py)
Register (views.py)
Model Views with Files and Images
Define your model (models.py)
Define your Views (views.py)
Next step
Quick Minimal Application
How to setup a minimal Application
Model Relations/Composite keys
Many to One
Many to Many
Many to Many with extra properties
Composite Keys
Actions
Define your view
Advanced Configuration
Security
Custom Fields
Base Filtering
Default Order
Template Extra Arguments
Forms - Override automatic form creation
Forms - Add or remove fields
Forms - Readonly fields
Forms - Custom validation rules
Forms - Custom query on related fields
Forms - Related fields
Customizing
Changing themes
Changing the index
Changing the Footer
Changing Menu Construction
Changing Widgets and Templates
Change Default View Behaviour
Templates
CSS and Javascript
Navigation Bar
List Templates
Add Templates
Edit Templates
Show Templates
Edit/Show Cascade Templates
Widgets
Example 1: Custom list widget
Example 2: Custom show widget
Other widget types
Library Functions
AddOn development
Generic Data Sources
PS Command example
Multiple Databases
i18n Translations
Introduction
Initial Configuration
Quick How to
Security
Supported Authentication Types
Authentication Methods
Authentication: Database
Authentication: OpenID
Authentication: LDAP
Authentication: OAuth
Role based
Permissions
Permission Customization
Automatic Cleanup
Auditing
Password complexity validation
Your Custom Security
Extending the User Model
User Registration
Database Authentication
OpenID Authentication
LDAP Authentication
Configuration
Diagrams
Class View Diagram Tree
Class Data Diagram Tree
Class Security Diagram Tree
Security Models ERD
API Reference
flask_appbuilder
AppBuilder
flask_appbuilder.security.decorators
flask_appbuilder.models.decorators
flask_appbuilder.hooks
flask_appbuilder.api
BaseApi
ModelRestApi
flask_appbuilder.baseviews
BaseView
BaseFormView
BaseModelView
BaseCRUDView
flask_appbuilder.views
IndexView
SimpleFormView
PublicFormView
ModelView
MultipleView
MasterDetailView
CompactCRUDMixin
flask_appbuilder.actions
flask_appbuilder.security
BaseSecurityManager
BaseRegisterUser
flask_appbuilder.filemanager
Aggr Functions for Group By Charts
flask_appbuilder.charts.views
BaseChartView
DirectByChartView
GroupByChartView
(Deprecated) ChartView
(Deprecated) TimeChartView
(Deprecated) DirectChartView
flask_appbuilder.models.mixins
Extra Columns
Generic Data Source (Beta)
flask_appbuilder.models.generic
Version Migration
Migrating to 1.9.0
Migrating to 1.8.0
Migrating from 1.2.X to 1.3.X
Migrating from 1.1.X to 1.2.X
Migrating from 0.9.X to 0.10.X
Migrating from 0.8.X to 0.9.X
Migrating from 0.6.X to 0.7.X
Migrating from 0.5.X to 0.6.X
Migrating from 0.2.X to 0.3.X
Migrating from 0.1.X to 0.2.X
Flask-AppBuilder
Docs
»
Search
Edit on GitHub
Please activate JavaScript to enable the search functionality.
Read the Docs
v: v3.4.0
Versions
latest
v3.4.0
v3.3.3
v3.2.0
v3.1.0
v3.0.0
v2.2.4
v2.2.3
v2.2.2
v2.2.1
v1.13.0
v1.8.1
Downloads
html
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.