Merge pull request #26 from ESA-PhiLab/refactor-extensions

Refactor extensions

Author: aliFrancis

README.md

@@ -3,7 +3,7 @@
 
 <img src="preview/segmentation.png" />
 
-Tool for manual image segmentation and classification of satellite imagery (or images in general). It was designed to accelerate the creation of machine learning training datasets for Earth Observation. This application is a flask app which can be run locally. Special highlights:
+Tool for manual image segmentation of satellite imagery (or images in general). It was designed to accelerate the creation of machine learning training datasets for Earth Observation. This application is a flask app which can be run locally. Special highlights:
 * Support by AI (gradient boosted decision tree) when doing image segmentation
 * Multiple and configurable views for multispectral imagery
 * Simple setup with pip and one configuration file

demo/cloud-segmentation.json

@@ -1,6 +1,5 @@
 {
   "name": "cloud-segmentation",
-  "authentication_required": true,
   "images": {
       "path": {
           "Sentinel1": "images/{id}/s1.tif",

docs/config.md

@@ -4,7 +4,6 @@ To use IRIS, you need to define a project file in JSON or YAML format. A full-wo
 
 - [Project file configurations](#project-file-configurations)
   * [name](#name)
-  * [authentication_required](#authentication_required)
   * [port](#port)
   * [host](#host)
   * [images](#images)
@@ -20,14 +19,6 @@ Optional name for this project.
 "name": "cloud-segmentation"
 ```
 
-## authentication_required
-Defines whether you want to use IRIS with or without user authentication (latter is not yet implemented).
-
-<i>Example:</i>
-```
-"authentication_required": true
-```
-
 ## port
 Set the port which IRIS is served on. Defaults to 5000.
 <i>Example:</i>

iris/__init__.py

@@ -7,11 +7,10 @@
 import webbrowser
 
 import flask
-from flask_sqlalchemy import SQLAlchemy
 import numpy as np
 import yaml
 
-import iris.extensions
+from iris.extensions import db, compress
 from iris.project import project
 
 def get_demo_file(example=None):
@@ -52,7 +51,7 @@ def parse_cmd_line():
     return vars(args)
 
 def run_app():
-    create_default_admin(app, db)
+    create_default_admin(app)
     if args['production']:
         import gevent.pywsgi
         app_server = gevent.pywsgi.WSGIServer((project['host'], project['port']), app)
@@ -65,25 +64,24 @@ def create_app(project_file, args):
     project.load_from(project_file)
     project.debug = args['debug']
 
+
     # Create the flask app:
     app = flask.Flask(__name__)
-    # app.config['TESTING'] = True
-    app.config['EXPLAIN_TEMPLATE_LOADING'] = True
-
-    # We need this secret key to encrypt cookies
-    app.secret_key = os.urandom(16)
 
-    # Database stuff:
+    app.config.from_pyfile('config.py')
     app.config['SQLALCHEMY_DATABASE_URI'] = \
         'sqlite:///' + join(project['path'], 'iris.db')
-    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
-    db = SQLAlchemy(app)
 
-    return app, db
+    # Register the extensions:
+    db.init_app(app)
+    compress.init_app(app)
+
+    return app
 
-def create_default_admin(app, db):
+def create_default_admin(app):
     # Add a default admin account:
-    admin = User.query.filter_by(name='admin').first()
+    with app.app_context():
+        admin = User.query.filter_by(name='admin').first()
     if admin is not None:
         return
 
@@ -105,18 +103,12 @@ def create_default_admin(app, db):
         admin=True,
     )
     admin.set_password(password)
-    db.session.add(admin)
-    db.session.commit()
+    with app.app_context():
+        db.session.add(admin)
+        db.session.commit()
 
 def register_extensions(app):
-    # Reduce the amount of transferred data by compressing it:
-    iris.extensions.Compress(app)
-    app.config['COMPRESS_MIMETYPES'] = [
-        'text/html', 'text/css', 'text/xml',
-        'application/json', 'application/octet-stream',
-        'application/javascript'
-    ]
-
+    
     from iris.main import main_app
     app.register_blueprint(main_app)
     from iris.segmentation import segmentation_app
@@ -136,11 +128,12 @@ def register_extensions(app):
     }
     args['project'] = get_demo_file()
 
-app, db = create_app(args['project'], args)
+app = create_app(args['project'], args)
 from iris.models import User, Action
 
-db.create_all()
-db.session.commit()
+with app.app_context():
+    db.create_all()
+    db.session.commit()
 
 register_extensions(app)
 

iris/config.py

@@ -0,0 +1,15 @@
+import os
+
+# General settings
+SECRET_KEY = os.urandom(24)
+EXPLAIN_TEMPLATE_LOADING = True
+
+# Flask-SQLAlchemy settings
+SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+# Flask-Compress settings
+COMPRESS_MIMETYPES = [
+        'text/html', 'text/css', 'text/xml',
+        'application/json', 'application/octet-stream',
+        'application/javascript'
+    ]

iris/default_config.json

@@ -1,6 +1,5 @@
 {
     "port": 5000,
-    "authentication_required": true,
     "images": {
         "thumbnails": false,
         "metadata": false

iris/extensions.py

@@ -1 +1,5 @@
 from flask_compress import Compress
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+compress = Compress()

iris/project.py

@@ -57,12 +57,6 @@ def load_from(self, filename):
         if 'name' not in self.config:
             self.config['name'] = ".".join(basename(filename).split(".")[:-1])
 
-        if isinstance(self['authentication_required'], str):
-            if self['authentication_required'].lower == 'false':
-                self['authentication_required'] = False
-            else:
-                self['authentication_required'] = True
-
         self._init_paths_and_files(filename)
 
         # Default seed

iris/tests/test_demo.py

@@ -15,7 +15,7 @@ def test_required_authentication(self):
         addresses = [
             # admin
             'admin/users', 'admin/images', 'admin/actions/segmentation',
-            'admin/actions/classification', 'admin/actions/detection',
+            'admin/actions/detection',
             # user
             'user/get/current', 'user/show/current', 'user/config',
             'user/save_config',

iris/user/templates/user/show.html

@@ -53,11 +53,6 @@ <h3>Last segmentation masks</h3>
             </table>
         {% endif %}
     </div>
-
-    <div class="accordion" onclick="toogle_display(this);">Classification</div>
-    <div class="panel">
-     <p>Not yet implemented...</p>
-    </div>
     {% if user.id == current_user.id %}
         <p>
             <button onclick="logout();">Logout</button>