updated requirements, added app factory pattern, linted

Author: mjhea0

.gitignore

@@ -4,8 +4,9 @@ venv
 __pycache__
 
 *.pyc
-*.sqlite
+*.db
 *.coverage
 .DS_Store
 env.sh
 migrations
+htmlcov

.python-version

@@ -1 +1 @@
-3.6.0
+3.6.3

LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016 Michael Herman
+Copyright (c) 2017 Michael Herman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -41,7 +41,7 @@ $ python manage.py create_data
 $ python manage.py runserver
 ```
 
-So access the application at the address [http://localhost:5000/](http://localhost:5000/)
+Access the application at the address [http://localhost:5000/](http://localhost:5000/)
 
 > Want to specify a different port?
 

manage.py

@@ -8,6 +8,10 @@
 from flask_script import Manager
 from flask_migrate import Migrate, MigrateCommand
 
+from project.server import create_app, db
+from project.server.models import User
+
+# code coverage
 COV = coverage.coverage(
     branch=True,
     include='project/*',
@@ -19,10 +23,7 @@
 )
 COV.start()
 
-from project.server import app, db
-from project.server.models import User
-
-
+app = create_app()
 migrate = Migrate(app, db)
 manager = Manager(app)
 

project/server/__init__.py

@@ -1,10 +1,6 @@
 # project/server/__init__.py
 
 
-#################
-#### imports ####
-#################
-
 import os
 
 from flask import Flask, render_template
@@ -13,79 +9,72 @@
 from flask_debugtoolbar import DebugToolbarExtension
 from flask_bootstrap import Bootstrap
 from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
 
 
-################
-#### config ####
-################
-
-app = Flask(
-    __name__,
-    template_folder='../client/templates',
-    static_folder='../client/static'
-)
-
-
-app_settings = os.getenv('APP_SETTINGS', 'project.server.config.DevelopmentConfig')
-app.config.from_object(app_settings)
-
-
-####################
-#### extensions ####
-####################
-
+# instantiate the extensions
 login_manager = LoginManager()
-login_manager.init_app(app)
-bcrypt = Bcrypt(app)
-toolbar = DebugToolbarExtension(app)
-bootstrap = Bootstrap(app)
-db = SQLAlchemy(app)
-
-
-###################
-### blueprints ####
-###################
-
-from project.server.user.views import user_blueprint
-from project.server.main.views import main_blueprint
-app.register_blueprint(user_blueprint)
-app.register_blueprint(main_blueprint)
-
-
-###################
-### flask-login ####
-###################
-
-from project.server.models import User
-
-login_manager.login_view = "user.login"
-login_manager.login_message_category = 'danger'
-
-
-@login_manager.user_loader
-def load_user(user_id):
-    return User.query.filter(User.id == int(user_id)).first()
-
-
-########################
-#### error handlers ####
-########################
-
-@app.errorhandler(401)
-def unauthorized_page(error):
-    return render_template("errors/401.html"), 401
-
-
-@app.errorhandler(403)
-def forbidden_page(error):
-    return render_template("errors/403.html"), 403
-
-
-@app.errorhandler(404)
-def page_not_found(error):
-    return render_template("errors/404.html"), 404
-
-
-@app.errorhandler(500)
-def server_error_page(error):
-    return render_template("errors/500.html"), 500
+bcrypt = Bcrypt()
+toolbar = DebugToolbarExtension()
+bootstrap = Bootstrap()
+db = SQLAlchemy()
+migrate = Migrate()
+
+
+def create_app():
+
+    # instantiate the app
+    app = Flask(
+        __name__,
+        template_folder='../client/templates',
+        static_folder='../client/static'
+    )
+
+    # set config
+    app_settings = os.getenv(
+        'APP_SETTINGS', 'project.server.config.DevelopmentConfig')
+    app.config.from_object(app_settings)
+
+    # set up extensions
+    login_manager.init_app(app)
+    bcrypt.init_app(app)
+    toolbar.init_app(app)
+    bootstrap.init_app(app)
+    db.init_app(app)
+    migrate.init_app(app, db)
+
+    # register blueprints
+    from project.server.user.views import user_blueprint
+    from project.server.main.views import main_blueprint
+    app.register_blueprint(user_blueprint)
+    app.register_blueprint(main_blueprint)
+
+    # flask login
+    from project.server.models import User
+    login_manager.login_view = 'user.login'
+    login_manager.login_message_category = 'danger'
+
+    @login_manager.user_loader
+    def load_user(user_id):
+        return User.query.filter(User.id == int(user_id)).first()
+
+        return app
+
+    # error handlers
+    @app.errorhandler(401)
+    def unauthorized_page(error):
+        return render_template('errors/401.html'), 401
+
+    @app.errorhandler(403)
+    def forbidden_page(error):
+        return render_template('errors/403.html'), 403
+
+    @app.errorhandler(404)
+    def page_not_found(error):
+        return render_template('errors/404.html'), 404
+
+    @app.errorhandler(500)
+    def server_error_page(error):
+        return render_template('errors/500.html'), 500
+
+    return app

project/server/config.py

@@ -20,7 +20,7 @@ class DevelopmentConfig(BaseConfig):
     DEBUG = True
     BCRYPT_LOG_ROUNDS = 4
     WTF_CSRF_ENABLED = False
-    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'dev.sqlite')
+    SQLALCHEMY_DATABASE_URI = f'sqlite:///{os.path.join(basedir, "dev.db")}'
     DEBUG_TB_ENABLED = True
 
 

project/server/main/views.py

@@ -1,25 +1,12 @@
 # project/server/main/views.py
 
 
-#################
-#### imports ####
-#################
-
 from flask import render_template, Blueprint
 
 
-################
-#### config ####
-################
-
 main_blueprint = Blueprint('main', __name__,)
 
 
-################
-#### routes ####
-################
-
-
 @main_blueprint.route('/')
 def home():
     return render_template('main/home.html')

project/server/models.py

@@ -3,12 +3,14 @@
 
 import datetime
 
-from project.server import app, db, bcrypt
+from flask import current_app
+
+from project.server import db, bcrypt
 
 
 class User(db.Model):
 
-    __tablename__ = "users"
+    __tablename__ = 'users'
 
     id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     email = db.Column(db.String(255), unique=True, nullable=False)
@@ -19,7 +21,7 @@ class User(db.Model):
     def __init__(self, email, password, admin=False):
         self.email = email
         self.password = bcrypt.generate_password_hash(
-            password, app.config.get('BCRYPT_LOG_ROUNDS')
+            password, current_app.config.get('BCRYPT_LOG_ROUNDS')
         ).decode('utf-8')
         self.registered_on = datetime.datetime.now()
         self.admin = admin

project/server/user/views.py

@@ -1,10 +1,6 @@
 # project/server/user/views.py
 
 
-#################
-#### imports ####
-#################
-
 from flask import render_template, Blueprint, url_for, \
     redirect, flash, request
 from flask_login import login_user, logout_user, login_required
@@ -13,17 +9,10 @@
 from project.server.models import User
 from project.server.user.forms import LoginForm, RegisterForm
 
-################
-#### config ####
-################
 
 user_blueprint = Blueprint('user', __name__,)
 
 
-################
-#### routes ####
-################
-
 @user_blueprint.route('/register', methods=['GET', 'POST'])
 def register():
     form = RegisterForm(request.form)