Added support for themes in bootswatch.com for b2 and b3

examples/swatch/README.rst

+This example shows how you can define your own custom forms by using form rendering rules. It also demonstrates general file handling as well as the handling of image files specifically.
+
+
+To run this example:
+
+1. Clone the repository::
+
+    git clone https://github.com/flask-admin/flask-admin.git
+    cd flask-admin
+
+2. Create and activate a virtual environment::
+
+    virtualenv env
+    source env/bin/activate
+
+3. Install requirements::
+
+    pip install -r 'examples/forms/requirements.txt'
+
+4. Run the application::
+
+    python examples/forms/app.py
+
+The first time you run this example, a sample sqlite database gets populated automatically. To suppress this behaviour,
+comment the following lines in app.py:::
+
+    if not os.path.exists(database_path):
+        build_sample_db()

examples/swatch/__init__.py

+__author__ = 'petrus'

examples/swatch/app.py

+import os
+import os.path as op
+
+from flask import Flask, url_for
+from flask_sqlalchemy import SQLAlchemy
+
+from sqlalchemy.event import listens_for
+from jinja2 import Markup
+
+from flask_admin import Admin, form
+from flask_admin.form import rules
+from flask_admin.contrib import sqla
+
+
+# Create application
+app = Flask(__name__, static_folder='files')
+
+
+# set flask admin swatch
+app.config['FLASK_ADMIN_SWATCH'] = 'cerulean'
+
+# Create dummy secrey key so we can use sessions
+app.config['SECRET_KEY'] = '123456790'
+
+# Create in-memory database
+app.config['DATABASE_FILE'] = 'sample_db.sqlite'
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + app.config['DATABASE_FILE']
+app.config['SQLALCHEMY_ECHO'] = True
+db = SQLAlchemy(app)
+
+# Create directory for file fields to use
+file_path = op.join(op.dirname(__file__), 'files')
+try:
+    os.mkdir(file_path)
+except OSError:
+    pass
+
+
+# Create models
+class File(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.Unicode(64))
+    path = db.Column(db.Unicode(128))
+
+    def __unicode__(self):
+        return self.name
+
+
+class Image(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.Unicode(64))
+    path = db.Column(db.Unicode(128))
+
+    def __unicode__(self):
+        return self.name
+
+
+class User(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    first_name = db.Column(db.Unicode(64))
+    last_name = db.Column(db.Unicode(64))
+    email = db.Column(db.Unicode(128))
+    phone = db.Column(db.Unicode(32))
+    city = db.Column(db.Unicode(128))
+    country = db.Column(db.Unicode(128))
+    notes = db.Column(db.UnicodeText)
+
+
+# Delete hooks for models, delete files if models are getting deleted
+@listens_for(File, 'after_delete')
+def del_file(mapper, connection, target):
+    if target.path:
+        try:
+            os.remove(op.join(file_path, target.path))
+        except OSError:
+            # Don't care if was not deleted because it does not exist
+            pass
+
+
+@listens_for(Image, 'after_delete')
+def del_image(mapper, connection, target):
+    if target.path:
+        # Delete image
+        try:
+            os.remove(op.join(file_path, target.path))
+        except OSError:
+            pass
+
+        # Delete thumbnail
+        try:
+            os.remove(op.join(file_path,
+                              form.thumbgen_filename(target.path)))
+        except OSError:
+            pass
+
+
+# Administrative views
+class FileView(sqla.ModelView):
+    # Override form field to use Flask-Admin FileUploadField
+    form_overrides = {
+        'path': form.FileUploadField
+    }
+
+    # Pass additional parameters to 'path' to FileUploadField constructor
+    form_args = {
+        'path': {
+            'label': 'File',
+            'base_path': file_path,
+            'allow_overwrite': False
+        }
+    }
+
+
+class ImageView(sqla.ModelView):
+    def _list_thumbnail(view, context, model, name):
+        if not model.path:
+            return ''
+
+        return Markup('<img src="%s">' % url_for('static',
+                                                 filename=form.thumbgen_filename(model.path)))
+
+    column_formatters = {
+        'path': _list_thumbnail
+    }
+
+    # Alternative way to contribute field is to override it completely.
+    # In this case, Flask-Admin won't attempt to merge various parameters for the field.
+    form_extra_fields = {
+        'path': form.ImageUploadField('Image',
+                                      base_path=file_path,
+                                      thumbnail_size=(100, 100, True))
+    }
+
+
+class UserView(sqla.ModelView):
+    """
+    This class demonstrates the use of 'rules' for controlling the rendering of forms.
+    """
+    form_create_rules = [
+        # Header and four fields. Email field will go above phone field.
+        rules.FieldSet(('first_name', 'last_name', 'email', 'phone'), 'Personal'),
+        # Separate header and few fields
+        rules.Header('Location'),
+        rules.Field('city'),
+        # String is resolved to form field, so there's no need to explicitly use `rules.Field`
+        'country',
+        # Show macro from Flask-Admin lib.html (it is included with 'lib' prefix)
+        rules.Container('rule_demo.wrap', rules.Field('notes'))
+    ]
+
+    # Use same rule set for edit page
+    form_edit_rules = form_create_rules
+
+    create_template = 'rule_create.html'
+    edit_template = 'rule_edit.html'
+
+
+# Flask views
+@app.route('/')
+def index():
+    return '<a href="/admin/">Click me to get to Admin!</a>'
+
+# Create admin
+admin = Admin(app, 'Example: Bootswatch', template_mode='bootstrap2')
+
+# Add views
+admin.add_view(FileView(File, db.session))
+admin.add_view(ImageView(Image, db.session))
+admin.add_view(UserView(User, db.session, name='User'))
+
+
+def build_sample_db():
+    """
+    Populate a small db with some example entries.
+    """
+
+    import random
+    import string
+
+    db.drop_all()
+    db.create_all()
+
+    first_names = [
+        'Harry', 'Amelia', 'Oliver', 'Jack', 'Isabella', 'Charlie','Sophie', 'Mia',
+        'Jacob', 'Thomas', 'Emily', 'Lily', 'Ava', 'Isla', 'Alfie', 'Olivia', 'Jessica',
+        'Riley', 'William', 'James', 'Geoffrey', 'Lisa', 'Benjamin', 'Stacey', 'Lucy'
+    ]
+    last_names = [
+        'Brown', 'Smith', 'Patel', 'Jones', 'Williams', 'Johnson', 'Taylor', 'Thomas',
+        'Roberts', 'Khan', 'Lewis', 'Jackson', 'Clarke', 'James', 'Phillips', 'Wilson',
+        'Ali', 'Mason', 'Mitchell', 'Rose', 'Davis', 'Davies', 'Rodriguez', 'Cox', 'Alexander'
+    ]
+    locations = [
+        ("Shanghai", "China"),
+        ("Istanbul", "Turkey"),
+        ("Karachi", "Pakistan"),
+        ("Mumbai", "India"),
+        ("Moscow", "Russia"),
+        ("Sao Paulo", "Brazil"),
+        ("Beijing", "China"),
+        ("Tianjin", "China"),
+        ("Guangzhou", "China"),
+        ("Delhi", "India"),
+        ("Seoul", "South Korea"),
+        ("Shenzhen", "China"),
+        ("Jakarta", "Indonesia"),
+        ("Tokyo", "Japan"),
+        ("Mexico City", "Mexico"),
+        ("Kinshasa", "Democratic Republic of the Congo"),
+        ("Bangalore", "India"),
+        ("New York City", "United States"),
+        ("London", "United Kingdom"),
+        ("Bangkok", "Thailand"),
+        ("Tehran", "Iran"),
+        ("Dongguan", "China"),
+        ("Lagos", "Nigeria"),
+        ("Lima", "Peru"),
+        ("Ho Chi Minh City", "Vietnam"),
+        ]
+
+    for i in range(len(first_names)):
+        user = User()
+        user.first_name = first_names[i]
+        user.last_name = last_names[i]
+        user.email = user.first_name.lower() + "@example.com"
+        tmp = ''.join(random.choice(string.digits) for i in range(10))
+        user.phone = "(" + tmp[0:3] + ") " + tmp[3:6] + " " + tmp[6::]
+        user.city = locations[i][0]
+        user.country = locations[i][1]
+        db.session.add(user)
+
+    images = ["Buffalo", "Elephant", "Leopard", "Lion", "Rhino"]
+    for name in images:
+        image = Image()
+        image.name = name
+        image.path = name.lower() + ".jpg"
+        db.session.add(image)
+
+    for i in [1, 2, 3]:
+        file = File()
+        file.name = "Example " + str(i)
+        file.path = "example_" + str(i) + ".pdf"
+        db.session.add(file)
+
+    db.session.commit()
+    return
+
+if __name__ == '__main__':
+
+    # Build a sample db on the fly, if one does not exist yet.
+    app_dir = op.realpath(os.path.dirname(__file__))
+    database_path = op.join(app_dir, app.config['DATABASE_FILE'])
+    if not os.path.exists(database_path):
+        build_sample_db()
+
+    # Start app
+    app.run(debug=True, use_reloader=True)

examples/swatch/requirements.txt

+Flask
+Flask-Admin
+Flask-SQLAlchemy
+pillow
\ No newline at end of file

examples/swatch/templates/admin/index.html

+{% extends 'admin/master.html' %}
+{% block body %}
+{{ super() }}
+<div class="container">
+    <div class="row">
+        <div class="span12">
+            <h1>Flask-Admin example</h1>
+            <p class="lead">
+                Bootswatch
+            </p>
+            <p>
+                This example shows how you can define a bootstrap swatch theme
+            </p>
+            <pre># set flask admin swatch
+app.config['FLASK_ADMIN_SWATCH'] = 'cerulean'</pre>
+            <p>
+                Available swatches in <a href="http://bootswatch.com/2/">http://bootswatch.com/2/</a>
+            </p>
+            <a class="btn btn-primary" href="/"><i class="glyphicon glyphicon-chevron-left"></i> Back</a>
+        </div>
+    </div>
+</div>
+{% endblock body %}

examples/swatch/templates/rule_create.html

+{% extends 'admin/model/create.html' %}
+{% import 'rule_demo.html' as rule_demo %}
\ No newline at end of file

examples/swatch/templates/rule_demo.html

+{% macro wrap() %}
+  <div style="border: 1px solid gray; background-color: #f0f0f0; padding-top: 8px; margin-bottom: 8px">
+    {{ caller() }}
+  </div>
+{% endmacro %}
\ No newline at end of file

examples/swatch/templates/rule_edit.html

+{% extends 'admin/model/edit.html' %}
+{% import 'rule_demo.html' as rule_demo %}

examples/swatch3/README.rst

+This example shows how you can define your own custom forms by using form rendering rules. It also demonstrates general file handling as well as the handling of image files specifically.
+
+
+To run this example:
+
+1. Clone the repository::
+
+    git clone https://github.com/flask-admin/flask-admin.git
+    cd flask-admin
+
+2. Create and activate a virtual environment::
+
+    virtualenv env
+    source env/bin/activate
+
+3. Install requirements::
+
+    pip install -r 'examples/forms/requirements.txt'
+
+4. Run the application::
+
+    python examples/forms/app.py
+
+The first time you run this example, a sample sqlite database gets populated automatically. To suppress this behaviour,
+comment the following lines in app.py:::
+
+    if not os.path.exists(database_path):
+        build_sample_db()

examples/swatch3/__init__.py

+__author__ = 'petrus'

examples/swatch3/app.py

+import os
+import os.path as op
+
+from flask import Flask, url_for
+from flask_sqlalchemy import SQLAlchemy
+
+from sqlalchemy.event import listens_for
+from jinja2 import Markup
+
+from flask_admin import Admin, form
+from flask_admin.form import rules
+from flask_admin.contrib import sqla
+
+
+# Create application
+app = Flask(__name__, static_folder='files')
+
+
+# set flask admin swatch
+app.config['FLASK_ADMIN_SWATCH'] = 'cerulean'
+
+# Create dummy secrey key so we can use sessions
+app.config['SECRET_KEY'] = '123456790'
+
+# Create in-memory database
+app.config['DATABASE_FILE'] = 'sample_db.sqlite'
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + app.config['DATABASE_FILE']
+app.config['SQLALCHEMY_ECHO'] = True
+db = SQLAlchemy(app)
+
+# Create directory for file fields to use
+file_path = op.join(op.dirname(__file__), 'files')
+try:
+    os.mkdir(file_path)
+except OSError:
+    pass
+
+
+# Create models
+class File(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.Unicode(64))
+    path = db.Column(db.Unicode(128))
+
+    def __unicode__(self):
+        return self.name
+
+
+class Image(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.Unicode(64))
+    path = db.Column(db.Unicode(128))
+
+    def __unicode__(self):
+        return self.name
+
+
+class User(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    first_name = db.Column(db.Unicode(64))
+    last_name = db.Column(db.Unicode(64))
+    email = db.Column(db.Unicode(128))
+    phone = db.Column(db.Unicode(32))
+    city = db.Column(db.Unicode(128))
+    country = db.Column(db.Unicode(128))
+    notes = db.Column(db.UnicodeText)
+
+
+# Delete hooks for models, delete files if models are getting deleted
+@listens_for(File, 'after_delete')
+def del_file(mapper, connection, target):
+    if target.path:
+        try:
+            os.remove(op.join(file_path, target.path))
+        except OSError:
+            # Don't care if was not deleted because it does not exist
+            pass
+
+
+@listens_for(Image, 'after_delete')
+def del_image(mapper, connection, target):
+    if target.path:
+        # Delete image
+        try:
+            os.remove(op.join(file_path, target.path))
+        except OSError:
+            pass
+
+        # Delete thumbnail
+        try:
+            os.remove(op.join(file_path,
+                              form.thumbgen_filename(target.path)))
+        except OSError:
+            pass
+
+
+# Administrative views
+class FileView(sqla.ModelView):
+    # Override form field to use Flask-Admin FileUploadField
+    form_overrides = {
+        'path': form.FileUploadField
+    }
+
+    # Pass additional parameters to 'path' to FileUploadField constructor
+    form_args = {
+        'path': {
+            'label': 'File',
+            'base_path': file_path,
+            'allow_overwrite': False
+        }
+    }
+
+
+class ImageView(sqla.ModelView):
+    def _list_thumbnail(view, context, model, name):
+        if not model.path:
+            return ''
+
+        return Markup('<img src="%s">' % url_for('static',
+                                                 filename=form.thumbgen_filename(model.path)))
+
+    column_formatters = {
+        'path': _list_thumbnail
+    }
+
+    # Alternative way to contribute field is to override it completely.
+    # In this case, Flask-Admin won't attempt to merge various parameters for the field.
+    form_extra_fields = {
+        'path': form.ImageUploadField('Image',
+                                      base_path=file_path,
+                                      thumbnail_size=(100, 100, True))
+    }
+
+
+class UserView(sqla.ModelView):
+    """
+    This class demonstrates the use of 'rules' for controlling the rendering of forms.
+    """
+    form_create_rules = [
+        # Header and four fields. Email field will go above phone field.
+        rules.FieldSet(('first_name', 'last_name', 'email', 'phone'), 'Personal'),
+        # Separate header and few fields
+        rules.Header('Location'),
+        rules.Field('city'),
+        # String is resolved to form field, so there's no need to explicitly use `rules.Field`
+        'country',
+        # Show macro from Flask-Admin lib.html (it is included with 'lib' prefix)
+        rules.Container('rule_demo.wrap', rules.Field('notes'))
+    ]
+
+    # Use same rule set for edit page
+    form_edit_rules = form_create_rules
+
+    create_template = 'rule_create.html'
+    edit_template = 'rule_edit.html'
+
+
+# Flask views
+@app.route('/')
+def index():
+    return '<a href="/admin/">Click me to get to Admin!</a>'
+
+# Create admin
+admin = Admin(app, 'Example: Bootswatch', template_mode='bootstrap3')
+
+# Add views
+admin.add_view(FileView(File, db.session))
+admin.add_view(ImageView(Image, db.session))
+admin.add_view(UserView(User, db.session, name='User'))
+
+
+def build_sample_db():
+    """
+    Populate a small db with some example entries.
+    """
+
+    import random
+    import string
+
+    db.drop_all()
+    db.create_all()
+
+    first_names = [
+        'Harry', 'Amelia', 'Oliver', 'Jack', 'Isabella', 'Charlie','Sophie', 'Mia',
+        'Jacob', 'Thomas', 'Emily', 'Lily', 'Ava', 'Isla', 'Alfie', 'Olivia', 'Jessica',
+        'Riley', 'William', 'James', 'Geoffrey', 'Lisa', 'Benjamin', 'Stacey', 'Lucy'
+    ]
+    last_names = [
+        'Brown', 'Smith', 'Patel', 'Jones', 'Williams', 'Johnson', 'Taylor', 'Thomas',
+        'Roberts', 'Khan', 'Lewis', 'Jackson', 'Clarke', 'James', 'Phillips', 'Wilson',
+        'Ali', 'Mason', 'Mitchell', 'Rose', 'Davis', 'Davies', 'Rodriguez', 'Cox', 'Alexander'
+    ]
+    locations = [
+        ("Shanghai", "China"),
+        ("Istanbul", "Turkey"),
+        ("Karachi", "Pakistan"),
+        ("Mumbai", "India"),
+        ("Moscow", "Russia"),
+        ("Sao Paulo", "Brazil"),
+        ("Beijing", "China"),
+        ("Tianjin", "China"),
+        ("Guangzhou", "China"),
+        ("Delhi", "India"),
+        ("Seoul", "South Korea"),
+        ("Shenzhen", "China"),
+        ("Jakarta", "Indonesia"),
+        ("Tokyo", "Japan"),
+        ("Mexico City", "Mexico"),
+        ("Kinshasa", "Democratic Republic of the Congo"),
+        ("Bangalore", "India"),
+        ("New York City", "United States"),
+        ("London", "United Kingdom"),
+        ("Bangkok", "Thailand"),
+        ("Tehran", "Iran"),
+        ("Dongguan", "China"),
+        ("Lagos", "Nigeria"),
+        ("Lima", "Peru"),
+        ("Ho Chi Minh City", "Vietnam"),
+        ]
+
+    for i in range(len(first_names)):
+        user = User()
+        user.first_name = first_names[i]
+        user.last_name = last_names[i]
+        user.email = user.first_name.lower() + "@example.com"
+        tmp = ''.join(random.choice(string.digits) for i in range(10))
+        user.phone = "(" + tmp[0:3] + ") " + tmp[3:6] + " " + tmp[6::]
+        user.city = locations[i][0]
+        user.country = locations[i][1]
+        db.session.add(user)
+
+    images = ["Buffalo", "Elephant", "Leopard", "Lion", "Rhino"]
+    for name in images:
+        image = Image()
+        image.name = name
+        image.path = name.lower() + ".jpg"
+        db.session.add(image)
+
+    for i in [1, 2, 3]:
+        file = File()
+        file.name = "Example " + str(i)
+        file.path = "example_" + str(i) + ".pdf"
+        db.session.add(file)
+
+    db.session.commit()
+    return
+
+if __name__ == '__main__':
+
+    # Build a sample db on the fly, if one does not exist yet.
+    app_dir = op.realpath(os.path.dirname(__file__))
+    database_path = op.join(app_dir, app.config['DATABASE_FILE'])
+    if not os.path.exists(database_path):
+        build_sample_db()
+
+    # Start app
+    app.run(debug=True, use_reloader=True)

examples/swatch3/requirements.txt

+Flask
+Flask-Admin
+Flask-SQLAlchemy
+pillow
\ No newline at end of file

examples/swatch3/templates/admin/index.html

+{% extends 'admin/master.html' %}
+{% block body %}
+{{ super() }}
+<div class="container">
+    <div class="row">
+        <div class="col-sm-10 col-sm-offset-1">
+            <h1>Flask-Admin example</h1>
+            <p class="lead">
+                Bootswatch
+            </p>
+            <p>
+                This example shows how you can define a bootstrap swatch theme
+            </p>
+            <pre># set flask admin swatch
+app.config['FLASK_ADMIN_SWATCH'] = 'cerulean'</pre>
+            <p>
+                Available swatches in <a href="http://bootswatch.com">http://bootswatch.com</a>
+            </p>
+            <a class="btn btn-primary" href="/"><i class="glyphicon glyphicon-chevron-left"></i> Back</a>
+        </div>
+    </div>
+</div>
+{% endblock body %}

examples/swatch3/templates/rule_create.html

+{% extends 'admin/model/create.html' %}
+{% import 'rule_demo.html' as rule_demo %}
\ No newline at end of file

examples/swatch3/templates/rule_demo.html

+{% macro wrap() %}
+  <div style="border: 1px solid gray; background-color: #f0f0f0; padding-top: 8px; margin-bottom: 8px">
+    {{ caller() }}
+  </div>
+{% endmacro %}
\ No newline at end of file

examples/swatch3/templates/rule_edit.html

+{% extends 'admin/model/edit.html' %}
+{% import 'rule_demo.html' as rule_demo %}

flask_admin/templates/bootstrap2/admin/base.html

@@ -12,7 +12,7 @@
         <meta name="author" content="">
     {% endblock %}
     {% block head_css %}
-        <link href="{{ admin_static.url(filename='bootstrap/bootstrap2/css/bootstrap.css', v='2.3.2') }}" rel="stylesheet">
+        <link href="{{ admin_static.url(filename='bootstrap/bootstrap2/swatch/{swatch}/bootstrap.min.css'.format(swatch=config.get('FLASK_ADMIN_SWATCH', 'default')), v='2.3.2') }}" rel="stylesheet">
         <link href="{{ admin_static.url(filename='bootstrap/bootstrap2/css/bootstrap-responsive.css', v='2.3.2') }}" rel="stylesheet">
         <link href="{{ admin_static.url(filename='admin/css/bootstrap2/admin.css', v='1.1.1') }}" rel="stylesheet">
         <style>

flask_admin/templates/bootstrap3/admin/base.html

@@ -12,8 +12,10 @@
         <meta name="author" content="">
     {% endblock %}
     {% block head_css %}
-        <link href="{{ admin_static.url(filename='bootstrap/bootstrap3/css/bootstrap.min.css', v='3.3.5') }}" rel="stylesheet">
+        <link href="{{ admin_static.url(filename='bootstrap/bootstrap3/swatch/{swatch}/bootstrap.min.css'.format(swatch=config.get('FLASK_ADMIN_SWATCH', 'default')), v='3.3.5') }}" rel="stylesheet">
+        {%if config.get('FLASK_ADMIN_SWATCH', 'default') == 'default' %}
         <link href="{{ admin_static.url(filename='bootstrap/bootstrap3/css/bootstrap-theme.min.css', v='3.3.5') }}" rel="stylesheet">
+        {%endif%}
         <link href="{{ admin_static.url(filename='admin/css/bootstrap3/admin.css', v='1.1.1') }}" rel="stylesheet">
         <style>
         body {