Add flask manager and config script

Author: rleh

config/__init__.py

@@ -0,0 +1,27 @@
+import os
+
+BASE_PATH = os.path.abspath(os.path.dirname(__file__))
+
+PRODUCTION_CONF_PATH = '/etc/hwut_server/production.py'
+TESTING_CONF_PATH = os.path.join(BASE_PATH, 'testing.py')
+
+
+def to_envvar(path=None):
+    """
+    Loads the application configuration from a file.
+    Returns the configuration or None if no configuration could be found.
+    """
+
+    if path:
+        path = os.path.abspath(path)
+        if not os.path.exists(path):
+            return
+    elif os.path.exists(PRODUCTION_CONF_PATH):
+        path = PRODUCTION_CONF_PATH
+    elif os.path.exists(TESTING_CONF_PATH):
+        path = TESTING_CONF_PATH
+    else:
+        return True
+
+    os.environ['HWUT_CONFIG'] = path
+    return True

config/testing.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+TESTING = True
+
+DEBUG = True
+SQLALCHEMY_ECHO = True
+
+ADMINS = frozenset(['[email protected]'])
+
+SQLALCHEMY_DATABASE_URI = 'postgres://postgres:postgres@localhost/hwut_testing'
+DATABASE_CONNECT_OPTIONS = {}
+
+SQLALCHEMY_TRACK_MODIFICATIONS = True

config_file_testing.py

@@ -7,7 +7,7 @@
 
 ADMINS = frozenset(['[email protected]'])
 
-SQLALCHEMY_DATABASE_URI = 'postgres://postgres:postgres@localhost/hwut'
+SQLALCHEMY_DATABASE_URI = 'sqlite://hwut.db'
 DATABASE_CONNECT_OPTIONS = {}
 
 SQLALCHEMY_TRACK_MODIFICATIONS = True

hwut_server/api/about.py

@@ -2,6 +2,8 @@
 
 from hwut_server.__about__ import git_hash, git_branch, __version__
 
+from hwut_server.decorators import requires_authentication
+
 mod = Blueprint('about', __name__)
 
 
@@ -16,3 +18,12 @@ def version():
         'git_branch': git_branch,
     }
     return jsonify(version_info)
+
+@mod.route('/auth_test', methods=['GET'])
+@requires_authentication
+def auth_test():
+    """
+    Show version information
+    """
+    auth_info = 'You\'re authenticated if you can read this.'
+    return jsonify(auth_info)

hwut_server/app.py

@@ -1,3 +1,6 @@
+import os
+import config
+
 from flask import Flask
 
 from hwut_server.api import register as register_api
@@ -9,14 +12,15 @@ def __init__(self, name='hwut_server', config_file=None, *args, **kw):
         # Create Flask instance
         super(HwutServer, self).__init__(name, *args, **kw)
 
-        # Load default settings and from environment variable
-        # self.config.from_pyfile(config.DEFAULT_CONF_PATH)
-        #
-        # if 'HWUT_CONFIG' in os.environ:
-        #    self.config.from_pyfile(os.environ['HWUT_CONFIG'])
-        #
         if config_file:
+            print('Loading config from file: config_file = {}'.format(config_file))
             self.config.from_pyfile(config_file)
+        elif 'HWUT_CONFIG' in os.environ:
+            print('Loading config from env: HWUT_CONFIG = {}'.format(os.environ['HWUT_CONFIG']))
+            self.config.from_pyfile(os.environ['HWUT_CONFIG'])
+        else:
+            print('No config found. Exit.')
+            exit(1)
 
         register_api(self)
         register_runner_api(self)

hwut_server/commands/__init__.py

@@ -0,0 +1,29 @@
+import sys
+
+from flask_script import Manager
+
+from .shell import Shell
+from .server import Server
+
+from .database import manager as database_manager
+
+
+from hwut_server.app import create_app
+from config import to_envvar
+
+
+def _create_app(config):
+    if not to_envvar(config):
+        print('Config file "{}" not found.'.format(config))
+        sys.exit(1)
+
+    return create_app()
+
+
+manager = Manager(_create_app)
+
+manager.add_option('-c', '--config', dest='config', required=False)
+
+manager.add_command("shell", Shell())
+manager.add_command("runserver", Server())
+manager.add_command("db", database_manager)

hwut_server/commands/database.py

@@ -0,0 +1,21 @@
+from flask_script import Manager, prompt_bool
+
+from hwut_server.database import db
+
+manager = Manager(help="Perform database operations")
+
+
+@manager.command
+def create():
+    """ Initialize the database by creating the necessary tables and indices """
+
+    # create all tables and indices
+    db.create_all()
+
+
+@manager.command
+def drop():
+    """ Drops database tables """
+
+    if prompt_bool("Are you sure you want to lose all your data"):
+        db.drop_all()

hwut_server/commands/server.py

@@ -0,0 +1,8 @@
+from flask_script import Server as BaseServer
+from hwut_server.app import create_app
+
+
+class Server(BaseServer):
+    def handle(self, app, *args, **kw):
+        app = create_app()
+        super(Server, self).handle(app, *args, **kw)

hwut_server/commands/shell.py

@@ -0,0 +1,13 @@
+from flask_script import Shell as BaseShell
+
+from flask import current_app
+from hwut_server import models, database
+
+
+def make_context():
+    return dict(app=current_app, model=models, db=database.db)
+
+
+class Shell(BaseShell):
+    def __init__(self, *args, **kw):
+        super(Shell, self).__init__(make_context=make_context, *args, **kw)

manage.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+
+from hwut_server.commands import manager
+
+if __name__ == "__main__":
+    manager.run()

run_server.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+
+from setuptools import setup, find_packages
+
+about = {}
+with open("hwut_server/__about__.py") as fp:
+    exec(fp.read(), about)
+
+setup(
+    name=about['__title__'],
+    version=about['__version__'],
+    description=about['__summary__'],
+    author=about['__author__'],
+    author_email=about['__email__'],
+    url=about['__uri__'],
+    packages=find_packages(),
+    install_requires=[
+        'Flask >= 0.10.1',
+        'Flask_SQLAlchemy >= 2.1',
+        'SQLAlchemy >= 1.0.11',
+        'Werkzeug >= 0.11.3',
+        'passlib',
+        #'psycopg2',
+        'requests',
+        'flask_script',
+    ],
+)