# Flask-AppBuilder
**Repository Path**: jiafanzhang/Flask-AppBuilder
## Basic Information
- **Project Name**: Flask-AppBuilder
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-09
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Flask App Builder
=================
.. image:: https://travis-ci.org/dpgaspar/Flask-AppBuilder.png?branch=master
:target: https://travis-ci.org/dpgaspar/Flask-AppBuilder
.. image:: https://img.shields.io/pypi/v/Flask-AppBuilder.svg
:alt: PyPI
:target: https://pypi.org/project/Flask-AppBuilder/
.. image:: https://img.shields.io/badge/pyversions-3.6%2C3.7-blue.svg
:target: https://www.python.org/
.. image:: https://codecov.io/github/dpgaspar/Flask-AppBuilder/coverage.svg?branch=master
:target: https://codecov.io/github/dpgaspar/Flask-AppBuilder
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Simple and rapid application development framework, built on top of `Flask `_.
includes detailed security, auto CRUD generation for your models, google charts and much more.
Extensive configuration of all functionality, easily integrate with normal Flask/Jinja2 development.
- Documentation: `Documentation `_
- Mailing list: `Google group `_
- Chat: `Gitter `_
- Examples: `examples `_
Checkout installation video on `YouTube `_
Quick how to `Demo from the docs `_ (login has guest/welcome).
Change Log
----------
`Versions `_ for further detail on what changed.
BREAKING CHANGE on 3.0.0 (OAuth)
Major version 3, changed it's **OAuth** dependency from flask-oauth to authlib, due to this OAuth configuration
changed:
Before:
.. code-block::
OAUTH_PROVIDERS = [
{'name':'google', 'icon':'fa-google', 'token_key':'access_token',
'remote_app': {
'consumer_key':'GOOGLE KEY',
'consumer_secret':'GOOGLE SECRET',
'base_url':'https://www.googleapis.com/oauth2/v2/',
'request_token_params':{
'scope': 'email profile'
},
'request_token_url':None,
'access_token_url':'https://accounts.google.com/o/oauth2/token',
'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
}
]
Now:
.. code-block::
OAUTH_PROVIDERS = [
{'name':'google', 'icon':'fa-google', 'token_key':'access_token',
'remote_app': {
'client_id':'GOOGLE KEY',
'client_secret':'GOOGLE SECRET',
'api_base_url':'https://www.googleapis.com/oauth2/v2/',
'client_kwargs':{
'scope': 'email profile'
},
'request_token_url':None,
'access_token_url':'https://accounts.google.com/o/oauth2/token',
'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
}
]
Also make sure you change your dependency for flask-oauth to `authlib `_
Fixes, Bugs and contributions
-----------------------------
You're welcome to report bugs, propose new features, or even better contribute to this project.
`Issues, bugs and new features `_
`Contribute `_
Includes:
---------
- Database
- SQLAlchemy, multiple database support: sqlite, MySQL, ORACLE, MSSQL, DB2 etc.
- Partial support for MongoDB using MongoEngine.
- Multiple database connections support (Vertical partitioning).
- Easy mixin audit to models (created/changed by user, and timestamps).
- Security
- Automatic permissions lookup, based on exposed methods. It will grant all permissions to the Admin Role.
- Inserts on the Database all the detailed permissions possible on your application.
- Public (no authentication needed) and Private permissions.
- Role based permissions.
- Authentication support for OAuth, OpenID, Database, LDAP and REMOTE_USER environ var.
- Support for self user registration.
- Views and Widgets
- Automatic menu generation.
- Automatic CRUD generation.
- Multiple actions on db records.
- Big variety of filters for your lists.
- Various view widgets: lists, master-detail, list of thumbnails etc
- Select2, Datepicker, DateTimePicker
- Related Select2 fields.
- Google charts with automatic group by or direct values and filters.
- AddOn system, write your own and contribute.
- CRUD REST API
- Automatic CRUD RESTful APIs.
- Internationalization
- Integration with flask-jwt-extended extension to protect your endpoints.
- Metadata for dynamic rendering.
- Selectable columns and metadata keys.
- Automatic and configurable data validation.
- Forms
- Automatic, Add, Edit and Show from Database Models
- Labels and descriptions for each field.
- Automatic base validators from model's definition.
- Custom validators, extra fields, custom filters for related dropdown lists.
- Image and File support for upload and database field association. It will handle everything for you.
- Field sets for Form's (Django style).
- i18n
- Support for multi-language via Babel
- Bootstrap 3.1.1 CSS and js, with Select2 and DatePicker
- Font-Awesome icons, for menu icons and actions.
Some pictures
-------------
Login page (with AUTH_DB)
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/login_db.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/login_db.png
Login page (with AUTH_OAUTH)
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/login_oauth.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/login_oauth.png
Security
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/security.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/security.png
Lists:
List contacts example
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/contact_list.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/contact_list.png
List Group example with search
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/group_list.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/group_list.png
Charts:
Group by pie chart
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/grouped_chart.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/grouped_chart.png
Direct time chart
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/direct_chart.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/chart_time1.png
Group by time chart
.. image:: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/chart_time2.png
:width: 480px
:target: https://raw.github.com/dpgaspar/flask-AppBuilder/master/images/chart_time2.png
Projects/Organizations using FAB
--------------------------------
If you would like to share your project, or let everyone know that you're using FAB
on your organization please submit a PR or send me an email with the details.
Projects:
- `Superset `_ - a data exploration platform designed to be visual, intuitive, and interactive
- `Airflow `_ - a platform to programmatically author, schedule, and monitor workflows.
Organizations:
- Miniclip
- EuroBIC
- `On Beat Digital `_
Depends on:
-----------
- flask
- click
- colorama
- flask-sqlalchemy
- flask-login
- flask-openid
- flask-wtform
- flask-Babel