Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Simple and extensible administrative interface framework for Flask
Python HTML JavaScript Makefile Shell CSS

This branch is 73 commits behind flask-admin:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
babel Add machine translations for new fileadmin strings, add Priit Laes's …
doc Remove dash from 'geo-alchemy' example name, so it can be imported.
examples
flask_admin fix floating point precision issues when converting filter string to …
.gitignore
.gitmodules
.travis.yml Rename dev requirements file. Add Sphinx & Nose.
AUTHORS Bumped version
LICENSE
MANIFEST.in Fixed #448. Exclude all .pyc files when building pypi package
Makefile
NOTICE Correct Bootstrap licensing info
README.rst README: Update testing instructions.
TODO.txt
projects.rst
requirements-dev.txt Rename dev requirements file. Add Sphinx & Nose.
setup.cfg Nose runs into import errors when looking for tests in contrib direct…
setup.py missed a comma, sorry

README.rst

Flask-Admin

The project was recently moved into its own organization. Please update your references to git@github.com:flask-admin/flask-admin.git.

https://d322cqt584bo4o.cloudfront.net/flask-admin/localized.png https://travis-ci.org/flask-admin/flask-admin.png?branch=master

Introduction

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.

Out-of-the-box, Flask-Admin plays nicely with various ORM's, including

It also boasts a simple file management interface and a redis client console.

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.

Examples

Several usage 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.

You can see some of these examples in action at http://examples.flask-admin.org. To run the examples on your local environment, one at a time, do something like:

cd flask-admin
python examples/simple/app.py

Documentation

Flask-Admin is extensively documented, you can find all of the documentation at http://flask-admin.readthedocs.org/en/latest/.

The docs are auto-generated from the .rst files in the /doc folder. So if you come across any errors, or if you think of anything else that should be included, then please make the changes and submit them as a pull-request.

To build the docs in your local environment, from the project directory:

pip install -r requirements-dev.txt
sudo make html

And if you want to preview any .rst snippets that you may want to contribute, go to http://rst.ninjs.org/.

Installation

To install Flask-Admin, simply:

pip install flask-admin

Or alternatively, you can download the repository and install manually by doing:

git clone git@github.com:flask-admin/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.

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

For all the tests to pass successfully, you'll need Postgres & MongoDB to be running locally. For Postgres:

CREATE DATABASE flask_admin_test;
CREATE EXTENSION postgis;

3rd Party Stuff

Flask-Admin is built with the help of Bootstrap and Select2.

If you want to localize your application, install the Flask-BabelEx package.

You can help improve Flask-Admin's translations through Crowdin: https://crowdin.com/project/flask-admin

Something went wrong with that request. Please try again.