Metadata-Version: 1.1
Name: Flask-Admin
Version: 1.0.9
Summary: Simple and extensible admin interface framework for Flask
Home-page: https://github.com/mrjoes/flask-admin/
Author: Serge S. Koval
Author-email: serge.koval+github@gmail.com
License: BSD
Description: Flask-Admin
        ===========
        
        .. image:: https://travis-ci.org/mrjoes/flask-admin.png?branch=master
        	:target: https://travis-ci.org/mrjoes/flask-admin
        
        Introduction
        ------------
        
        Flask-Admin is a batteries-included, simple-to-use `Flask <http://flask.pocoo.org/>`_ 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
        
        - `SQLAlchemy <http://www.sqlalchemy.org/>`_,
        
        - `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.
        
        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 <http://examples.flask-admin.org/>`_.
        To run that same page in your local environment, simply::
        
            cd flask-admin
            python examples/runserver.py
        
        Alternatively, you can run the examples one at a time, with something like::
        
            cd flask-admin
            python examples/simple/simple.py
        
        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 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::
        
            sudo pip install sphinx
            cd flask-admin
            sudo make html
        
        Or, if you want to preview any *.rst* snippets that you may want to contribute, go to `http://rst.ninjs.org/ <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: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/>`_.
        
        To run the tests, simply::
        
            pip install nose
        
        and then::
        
            cd flask-admin
            nosetests
        
        You should see output similar to::
        
            ...
            ----------------------------------------------------------------------
            Ran 41 tests in 2.092s
        
        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 `Bootstrap <http://getbootstrap.com/>`_ and `Select2 <https://github.com/ivaynberg/select2>`_.
        
        If you want to localize your application, install the `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>`_ package.
        
        
        Changelog
        =========
        
        1.0.9
        -----
        
        Highlights:
        
        * Bootstrap 3 support
        * WTForms 2.x support
        * Updated DateTime picker
        * SQLAlchemy backend: support for complex sortables, ability to search for related models, model inheritance support
        * Customizable URL generation logic for all views
        * New generic filter types: in list, empty, date range
        * Added the ``geoa`` contrib module, for working with `geoalchemy2 <http://geoalchemy-2.readthedocs.org/>`_
        * Portugese translation
        * Lots of bug fixes
        
        
        1.0.8
        -----
        
        Highlights:
        
        * Cleaned up documentation, many thanks to Petrus Janse van Rensburg.
        * More flexible menu system, ability to add links to menus
        * Human-readable filter URLs
        * Callable filter `options`
        * `EmailField` filter
        * Simple accessibility fixes
        * `InlineFormField` now accepts `widget_args` and `form_rules` arguments
        * Support for newer wtforms versions
        * `form_rules` property that affects both create and edit forms
        * Lots of bugfixes
        
        1.0.7
        -----
        
        Full change log and feature walkthrough can be found `here <http://mrjoes.github.io/2013/10/21/flask-admin-107.html>`_.
        
        Highlights:
        
        * Python 3 support
        * AJAX-based foreign-key data loading for all backends
        * New, optional, rule-based form rendering engine
        * MongoEngine fixes and features: GridFS support, nested subdocument configuration and much more
        * Greatly improved and more configurable inline models
        * New WTForms fields and widgets
        * `form_extra_columns` allows adding custom columns to the form declaratively
        * Redis cli
        * SQLAlchemy backend can handle inherited models with multiple PKs
        * Lots of bug fixes
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
