Flask-Admin is advanced, extensible and simple to use administrative interface building extension for the Flask framework.
Flask-Admin is a batteries-included, simple-to-use Flask extension that lets you add admin interfaces to Flask
applications. It is inspired by the *django-admin* package, but implemented in such a way that the developer has total control
of the look, feel and functionality of the resulting application.
It comes with batteries included: model scaffolding for `SQLAlchemy <http://www.sqlalchemy.org/>`_,
`MongoEngine <http://mongoengine.org/>`_, `pymongo <http://api.mongodb.org/python/current/>`_ and `Peewee <https://github.com/coleifer/peewee>`_ ORMs, simple
file management interface, redis client console and a lot of usage examples.
Out-of-the-box, Flask-Admin plays nicely with various ORM's, including
You're not limited by the default functionality - instead of providing simple scaffolding for the ORM
models, Flask-Admin provides tools that can be used to build administrative interface of any complexity,
using a consistent look and feel. Flask-Admin architecture is very flexible, there's no need to monkey-patch
anything, every single aspect of the library can be customized.
- `SQLAlchemy <http://www.sqlalchemy.org/>`_,
Flask-Admin is evolving project, extensively tested and production ready.
- `MongoEngine <http://mongoengine.org/>`_,
- `pymongo <http://api.mongodb.org/python/current/>`_ and
- `Peewee <https://github.com/coleifer/peewee>`_.
It also boasts a simple file management interface and a `redis client <http://redis.io/>`_ console.
Several usage examples are included in the */examples* folder. Feel free to add your own examples, or improve some of the existing ones, and submit them as a *pull-request*.
The biggest feature of Flask-Admin is flexibility. It aims to provide a set of simple tools that can be used for
building admin interfaces of any complexity. So, to start off with you can create a very simple application in no time,
with auto-generated CRUD-views for each of your models. But then you can go further and customize those views & forms
as the need arises.
Flask-Admin is an active project, well-tested and production ready.
Documentation
-------------
Flask-Admin is extensively documented, you can find all of the documentation at `http://readthedocs.org/docs/flask-admin <http://readthedocs.org/docs/flask-admin>`_.
The docs are auto-generated for the *.rst* files in the */doc* folder. So if you come across any errors, or think of anything that should be included, then please make the changes and submit them as a *pull-request*.
Installation
------------
To install Flask-Admin, simply::
pip install flask-admin
Or alternatively, you can download the repository and install manually by doing::
Flask-Admin is extensively documented, you can find `documentation here <http://readthedocs.org/docs/flask-admin>`_.
git clone git@github.com:mrjoes/flask-admin.git
cd flask-admin
python setup.py install
Tests
-----
Test are run with *nose*. If you are not familiar with this package you can get some more info from `their website <http://nose.readthedocs.org/>`_.
Please note that you will need to install some additional dependencies in order for all of the tests to be executed successfully.
3rd Party Stuff
---------------
Flask-Admin is built with the help of `Twitter Bootstrap <http://twitter.github.com/bootstrap/>`_ and `Select2 <https://github.com/ivaynberg/select2>`_.
If you want to localize administrative interface, install `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>` package.
Examples
--------
The library comes with a quite a few examples, you can find them in the `examples <https://github.com/mrjoes/flask-admin/tree/master/examples>` directory.
If you want to localize your application, install the `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>`_ package.
