/Flask-SuperAdmin

The best admin interface framework for Flask. With scaffolding for MongoEngine, Django and SQLAlchemy.

Primary LanguagePythonOtherNOASSERTION

Flask-SuperAdmin

Join the chat at https://gitter.im/syrusakbary/Flask-SuperAdmin https://travis-ci.org/SyrusAkbary/Flask-SuperAdmin.png?branch=master

Flask-Superadmin is the best admin interface framework for Flask. As good as Django admin.

Batteries included:

  • Admin interface
  • Scaffolding for MongoEngine, Django and SQLAlchemy
  • File administrator (optional)

Requirements:

Admin interface

Influenced heavily by the Django admin, provides easy create/edit/delete functionality for your project's models (MongoEngine, Django or SQLAlchemy).

https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-list.png https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-edit.png

Introduction

This is library for building administrative interface on top of Flask framework.

Instead of providing simple scaffolding for SQLAlchemy, MongoEngine or Django models, Flask-SuperAdmin provides tools that can be used to build administrative interface of any complexity, using consistent look and feel.

Small example (Flask initialization omitted):

from flask.ext.superadmin import Admin, model

app = Flask(__name__)
admin = Admin(app)

# For SQLAlchemy (User is a SQLAlchemy Model/Table)
admin.register(User, session=db.session)

# For MongoEngine Documents (User is a MongoEngine Document)
admin.register(User)

# For Django Models (User is a Django Model)
admin.register(User)


# Adding a custom view
admin.add_view(CustomView(name='Photos', category='Cats'))

admin.setup_app(app)

Installation

For installing you have to do:

pip install Flask-SuperAdmin

Or:

python setup.py install

Examples

Library comes with a lot of examples, you can find them in examples directory.

Documentation

Flask-SuperAdmin is extensively documented, you can find documentation here.

3rd Party Stuff

Flask-SuperAdmin is built with help of Twitter Bootstrap, Chosen, and jQuery.

Kudos

This library is a supervitamined fork of the Flask-Admin package by Serge S. Koval.