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

Syrus Akbary d0c02a0388 Merge pull request #130 from rgv151/Fix-#129 5 years ago
babel 67eb390803 Changed to SuperAdmin version 6 years ago
doc 553eb4eb34 Fixed doc index 6 years ago
examples 3a875c8ee0 Fix babelex package name 5 years ago
flask_superadmin 81f5a44571 Fix CSRF for deleting objects from list 5 years ago
screenshots c0a9ba94ff Changed screenshot name 6 years ago
.gitignore 5e98e3cca0 Removed and ignore mo files from repository 5 years ago
.gitmodules cf942a6eee Removed theme reference. 7 years ago
.travis.yml 6f60853fe7 include mongodb in the travis config 6 years ago
AUTHORS 28a72bc036 Added @noirbizarre to contributors. 5 years ago
Gruntfile.js e899b48b85 compatibility with jQuery 1.9 + Gruntfile + lint-free js 6 years ago
LICENSE 950e687663 Update LICENSE 6 years ago
MANIFEST.in 67eb390803 Changed to SuperAdmin version 6 years ago
Makefile 67eb390803 Changed to SuperAdmin version 6 years ago
README.rst f73150c2c5 Update Travis link 5 years ago
TODO.txt ade30af0ce Update TODO.txt 6 years ago
babel.cfg ac9a8c471b Added building scripts for translation. 6 years ago
logo.png 1e3471bbb6 Simplified ModelAdmin views, and added register method to Admin class 6 years ago
requirements.txt e761e9d21c Flask-WTF 0.9+ compatibility (drop support for earlier versions) 5 years ago
setup.cfg 3351215575 tests base + cleanup + comments 6 years ago
setup.py e761e9d21c Flask-WTF 0.9+ compatibility (drop support for earlier versions) 5 years ago

README.rst

Flask-SuperAdmin
================


.. image:: https://travis-ci.org/SyrusAkbary/Flask-SuperAdmin.png?branch=master
:target: https://travis-ci.org/SyrusAkbary/Flask-SuperAdmin

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:

* `Flask`_
* `WTForms `_


Admin interface
---------------

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


.. image:: https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-list.png
:width: 480px
:target: https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-list.png

.. image:: https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-edit.png
:width: 480px
:target: https://raw.github.com/SyrusAkbary/Flask-SuperAdmin/master/screenshots/model-edit.png


Introduction
------------

This is library for building adminstrative 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 adminstrative 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.

- `MongoEngine `_
- `SQLAlchemy `_
- `Django `_
- `Flask-Login integration `_


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.