Skip to main content

Simple and extensible admin interface framework for Flask

Project description

Flask-Admin

https://travis-ci.org/mrjoes/flask-admin.png?branch=master

Introduction

This is a library for building an administrative interface on top of the Flask framework.

Flask-Admin comes with a few batteries included: model scaffolding for SQLAlchemy, MongoEngine and Peewee ORMs as well as a simple file management interface.

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 construct administrative interfaces of any complexity, using a consistent look and feel.

Documentation

Flask-Admin is extensively documented, you can find documentation here.

3rd Party Stuff

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

If you want to localize administrative interface, install Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx> package.

Kudos

Some ideas were taken from the Flask-Admin by Andy Wilson.

Examples

The library comes with a few examples, you can find them in the examples <https://github.com/mrjoes/flask-admin/tree/master/examples directory.

Changelog

1.0.5

  • SQLAlchemy 0.8 support

  • Choices and PostgreSQL Enum field type support

  • Flask-BabelEx will be used to localize administrative interface

  • Simple text file editor

  • File admin has additional hooks: rename, edit, upload, etc

  • Simple text file editor

  • External links in menu

  • Column descriptions

  • Possibility to override master template

  • Reworked templates. New ‘layout’ sample with completely different administrative UI

  • Ability to customize wtforms widget rendering through form_widget_args property

  • German translation (WIP)

  • Updated documentation

  • Lots of bug fixes

1.0.4

  • MongoEngine support

  • Raw PyMongo support

  • Model property names are more consistent now

  • Revamped InlineForm implementation

  • Proper support of SQLAlchemy model inheritance

  • Updated to bootstrap 2.2.1

1.0.3

General:

  • Peewee 2.x support

  • Model form scaffolding is now customizable in model views

  • Inline model forms are much more customizable now

  • List view type-based formatters

  • Database NULL will be displayed in list view as empty string by default. Use type-based formatter if you want to show something else.

  • Use Select2 instead of Chosen

  • List view formatting callbacks. See example.

  • _template_args property is now available in all views

  • on_model_change and on_model_delete callbacks

  • Model backends now support list_display_pk property

  • Minor template refactoring, more blocks to override

  • Supported multiple Admin class instances for one Flask application

  • File uploads are now supported in model views

  • Use HTTPS CDN for jQuery

  • Lots of minor fixes

SQLAlchemy backend:

  • Support for non-nullable boolean fields

  • If create/delete/update fails, Flask-Admin will rollback the transaction

  • Default column values support

  • list_display_all_relations to show many-to-one relations in list view

  • get_query method, which can be overridden to implement additional filtering/sorting/etc

  • Synonym properties support

  • Backend will ignore protected fields (name starting with underscore) from now on

  • Support for various PostgreSQL fields

1.0.2

  • Peewee model backend

  • Inline form administration interface for models a-la Django

  • Mass actions - methods that work with more than one item (for example - mass delete for models or files)

  • SQLAlchemy form scaffolding is now independent from the wtforms.ext.sqlalchemy helpers

  • Added ability to mount administrative interface as a top-level folder

  • Administrative interface can now be mounted as a subdomain

  • Can now use FileField in model admin

  • Revamped model templates, much more customizable now

  • Model list view column formatting callbacks

  • Lots of bugfixes

1.0.1

  • Fixed setup manifest

1.0.0

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Admin-1.0.5.tar.gz (219.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page