Fairy-Admin

This is a shell package which add Layui based template to Flask-Admin

Currently, only SQLAlchemy backend supported.

Install

pip install git+https://github.com/lvqier/fairy-admin.git

Usage

To use Fairy-Admin, replace flask_admin.Admin with fairy_admin.FairyAdmin and pass 'layui' for the template_mode parameter. Then extend your views from fairy_admin.contrib.sqla.ModelView.

For example:

from fairy_admin import FairyAdmin
from fairy_admin.contrib.sqla import ModelView
from fairy_admin.form import ActionForm
from fairy_admin.actions import action
from wtforms import fields, validators

# from somewhere import db, SampleModel

admin = FairyAdmin(template_mode='layui')
# use admin as usual

class SampleModelView(ModelView):
    class SampleForm(ActionForm):
        text = fields.TextField('Text', validators=[validators.Required()])

        def on_prefill(self, ids):
            if not ids:
                return
            item = SampleModelView.self.get_one(ids[0])
            self.text.process_data(item.text)

    @action('sample_action', 'Sample Action', form=SampleForm)
    def sample_action(self, ids, form=None):
        # process form.text.data
        pass

admin.add_view(SampleModelView(SampleModel, db.session))

Additional features

• Role based access control.
• Implement sub-admin for tenants.
• Implement sub-view for model relationships.
• Support form with view actions.

Migrate from Flask-Admin

Flask-Admin	Fairy-Admin
flask_admin.Admin	fairy_admin.FairyAdmin
flask_admin.BaseModelView	fairy_admin.BaseModelView
flask_admin.contrib.sqla.ModelView	fairy_admin.contrib.sqla.ModelView
flask_admin.actions.action	fairy_admin.actions.action
flask_admin.form.FileUploadField	fairy_admin.form.FileUploadField
flask_admin.form.ImageUploadField	fairy_admin.form.ImageUploadField