Admin Bundle

Integrates Flask Admin with Flask Unchained.

Installation

Install dependencies:

pip install "flask-unchained[admin]"

Enable the bundle in your unchained_config.py:

# project-root/unchained_config.py

BUNDLES = [
    # ...
    'flask_unchained.bundles.admin',
    'app',
]

And include the Admin Bundle’s routes:

# project-root/your_app_bundle/routes.py

routes = lambda: [
    include('flask_unchained.bundles.admin.routes'),
    # ...
]

Config

class flask_unchained.bundles.admin.config.Config

Config class for the Admin bundle. Defines which configuration values this bundle supports, and their default values.

ADMIN_NAME = 'Admin'

The title of the admin section of the site.

ADMIN_BASE_URL = '/admin'

Base url of the admin section of the site.

ADMIN_INDEX_VIEW = <flask_unchained.bundles.admin.views.dashboard.AdminDashboardView object>

The AdminIndexView (or subclass) instance to use for the index view.

ADMIN_SUBDOMAIN = None

Subdomain of the admin section of the site.

ADMIN_BASE_TEMPLATE = 'admin/base.html'

Base template to use for other admin templates.

ADMIN_TEMPLATE_MODE = 'bootstrap4'

Which version of bootstrap to use. (bootstrap2, bootstrap3, or bootstrap4)

ADMIN_CATEGORY_ICON_CLASSES = {}

Dictionary of admin category icon classes. Keys are category names, and the values depend on which version of bootstrap you’re using.

For example, with bootstrap4:

ADMIN_CATEGORY_ICON_CLASSES = {
    'Mail': 'fa fa-envelope',
    'Security': 'fa fa-lock',
}

ADMIN_ADMIN_ROLE_NAME = 'ROLE_ADMIN'

The name of the Role which represents an admin.

ADMIN_LOGIN_ENDPOINT = 'admin.login'

Name of the endpoint to use for the admin login view.

ADMIN_POST_LOGIN_REDIRECT_ENDPOINT = 'admin.index'

Name of the endpoint to redirect to after the user logs into the admin.

ADMIN_LOGOUT_ENDPOINT = 'admin.logout'

Name of the endpoint to use for the admin logout view.

ADMIN_POST_LOGOUT_REDIRECT_ENDPOINT = 'admin.login'

Endpoint to redirect to after the user logs out of the admin.

API Docs

See Admin Bundle API