Flask-xAdmin
Flask-xAdmin is a extended-life batteries included, simple-to-use Flask extension that lets you add flexible admin interface to Flask applications. Flask-xAdmin is standing on the shoulders of Flask, SQLAlchemy, Flask-Security and Flask-Admin.
Introduction
Flask-xAdmin is a extended-life batteries-included, simple-to-use Flask extension that lets you add admin interfaces to Flask applications.
The goal of Flask-xAdmin is to give additional flexibility to Flask-Admin apps and make admin-app developer job easier.
Extended life means that apps built with Flask-xAdmin are smaller and more resistant to database model changes due to development process, thus providing admin app extended lifetime & flexibility.
Flask-xAdmin specific features are tested on SQLAlchemy.
Flask-xAdmin is a new project.
Examples
Examples are included in the /examples folder. Please feel free to add your own examples, or improve on some of the existing ones, and then submit them via GitHub as a pull-request.
simple.py
- start simple.py
- open in browser http://127.0.0.1:8001/xadmin/note/
- username/password: admin@example.com/password
- try to follow User relationship in Note table
- click at user icon to enter edit mode
- play ...
User vadmin@example.com/password does not have edit mode role. You can try to login as vadmin@example.com to see difference.
Documentation (todo)
Flask-xAdmin documentation will be published at https://flask-xadmin.readthedocs.io/en/latest/.
Installation
To install Flask-xAdmin, simply:
pip install flask-xadmin
Or alternatively, you can download the repository and install manually by doing:
git clone git@github.com:hexo-/flask-xadmin.git cd flask-xadmin python setup.py install
Tests (TODO)
Test are run with nose. If you are not familiar with this package you can get some more info from their website.
To run the tests, from the project directory, simply:
pip install -r requirements-dev.txt nosetests
You should see output similar to:
............................................. ---------------------------------------------------------------------- Ran 102 tests in 13.132s OK
Notes
This document is created from Flask-Admin/README.rst
Special thanks to Serge S. Koval, author of Flask-Admin and contributors.