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/>`_,
Out-of-the-box, Flask-Admin plays nicely with various ORM's, including
`MongoEngine <http://mongoengine.org/>`_, `pymongo <http://api.mongodb.org/python/current/>`_ and `Peewee <https://github.com/coleifer/peewee>`_ ORMs, simple
`SQLAlchemy <http://www.sqlalchemy.org/>`_,
file management interface, redis client console and a lot of usage examples.
`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.
You're not limited by the default functionality - instead of providing simple scaffolding for the ORM
Several usage examples are included in the */examples* folder. Feel free to add your own, or improve some of the existing ones, and submit them as a *pull-request*.
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.
Flask-Admin is evolving project, extensively tested and production ready.
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 `documentation here <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
Installation
------------
------------
...
@@ -28,6 +41,7 @@ To install Flask-Admin, simply::
...
@@ -28,6 +41,7 @@ To install Flask-Admin, simply::
Or alternatively, you can download the repository and install manually by doing::
Or alternatively, you can download the repository and install manually by doing::
git clone git@github.com:mrjoes/flask-admin.git
cd flask-admin
cd flask-admin
python setup.py install
python setup.py install
...
@@ -51,20 +65,9 @@ You should see output such as:
...
@@ -51,20 +65,9 @@ You should see output such as:
Please note that you will need to install some additional dependencies in order for all of the tests to be executed successfully.
Please note that you will need to install some additional dependencies in order for all of the tests to be executed successfully.
Documentation
-------------
Flask-Admin is extensively documented, you can find `documentation here <http://readthedocs.org/docs/flask-admin>`_.
3rd Party Stuff
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>`_.
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.
If you want to localize your application, install the `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.