Minor refactor.

Author: toddbirchard

.env.example

@@ -1,16 +1,14 @@
 ENVIRONMENT=production
-FLASK_APP=main.py
 FLASK_DEBUG=True
-SECRET_KEY=HGFDGGUFCJHDJCWDGCKDWWW
+SECRET_KEY=YourSecretKey
 
 REDIS_URI=redis://:password@host.com:1234
 
 SQLALCHEMY_DATABASE_URI=mysql+pymysql://myuser:mypassword@host.example.com:1234/mydatabase
-SQLALCHEMY_TRACK_MODIFICATIONS=False
 SQLALCHEMY_CA_CERTS="./certificate.crt"
+SQLALCHEMY_TRACK_MODIFICATIONS=False
+SQLALCHEMY_ECHO=False
 
 ASSETS_DEBUG=False
 LESS_RUN_IN_DEBUG=False
-COMPRESSOR_DEBUG=False
-ASSETS_DEBUG=False
-LESS_RUN_IN_DEBUG=False
+COMPRESSOR_DEBUG=False

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+select = E9,F63,F7,F82
+exclude = .git,.github,__pycache__,.pytest_cache,.venv,logs,creds

.gitignore

@@ -89,6 +89,7 @@ ENV/
 env.bak/
 venv.bak/
 .creds/
+.creds
 
 # Spyder project settings
 .spyderproject

Makefile

@@ -86,5 +86,5 @@ clean:
 	find . -type d -wholename '**/.pytest_cache' -exec rm -rf {} + && \
 	find . -type d -wholename '**/*.log' -exec rm -rf {} + && \
 	find . -type d -wholename './.reports/*' -exec rm -rf {} + && \
-	find . -type d -wholename '**/.webassets-cache' -exec rm -rf {} +
+	find . -type d -wholename '**/.webassets-cache' -exec rm -rf {}
 

README.md

@@ -18,15 +18,16 @@
 
 Get set up locally in two steps:
 
-### Environment Variables
+### Configure
 
 Replace the values in **.env.example** with your values and rename this file to **.env**:
 
+* `ENVIRONMENT`: Enable (`development` or `production`).
 * `FLASK_APP`: Entry point of your application; should be `main.py`.
 * `FLASK_DEBUG`: Toggle debug mode on (`True`) or off (`False`).
 * `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
-* `SQLALCHEMY_DATABASE_URI`: Connection URI of a SQL database.
-* `SESSION_REDIS`: Connection URI of a Redis instance.
+* `SQLALCHEMY_DATABASE_URI`: Connection URI of a SQL database (ie: `mysql+pymysql://myuser:mypassword@host.example.com:1234/mydatabase`)
+* `REDIS_URI`: Connection URI of a Redis instance (ie: `redis://:password@host.com:1234`)
 * `LESS_BIN` *(optional for static assets)*: Path to your local LESS installation via `which lessc`.
 * `ASSETS_DEBUG` *(optional)*: Debug asset creation and bundling in `development`.
 * `LESS_RUN_IN_DEBUG` *(optional)*: Debug LESS while in `development`.

config.py

@@ -13,7 +13,9 @@ class Config:
 
     # General Config
     ENVIRONMENT = environ.get("ENVIRONMENT")
-    FLASK_APP = environ.get("FLASK_APP")
+
+    # Flask Config
+    FLASK_APP = "main.py"
     FLASK_DEBUG = environ.get("FLASK_DEBUG")
     SECRET_KEY = environ.get("SECRET_KEY")
 
@@ -30,9 +32,9 @@ class Config:
     # Static Assets
     STATIC_FOLDER = "static"
     TEMPLATES_FOLDER = "templates"
-    COMPRESSOR_DEBUG = True
+    COMPRESSOR_DEBUG = environ.get("COMPRESSOR_DEBUG")
 
     # Flask-SQLAlchemy
     SQLALCHEMY_DATABASE_URI = environ.get("SQLALCHEMY_DATABASE_URI")
-    SQLALCHEMY_TRACK_MODIFICATIONS = False
-    SQLALCHEMY_ECHO = False
+    SQLALCHEMY_TRACK_MODIFICATIONS = environ.get("SQLALCHEMY_TRACK_MODIFICATIONS")
+    SQLALCHEMY_ECHO = environ.get("SQLALCHEMY_ECHO")

flask_session_tutorial/__init__.py

@@ -23,14 +23,14 @@ def create_app():
 
     with app.app_context():
         from . import auth
-        from .assets import compile_auth_assets, compile_static_assets
+        from .assets import compile_static_assets, compile_stylesheet_assets
 
         app.register_blueprint(main.main)
         app.register_blueprint(auth.auth)
 
         # Create static asset bundles
         compile_static_assets(app)
-        compile_auth_assets(app)
+        compile_stylesheet_assets(app)
 
         # Create Database Models
         db.create_all()

flask_session_tutorial/assets.py

@@ -1,50 +1,62 @@
 """Compile static asset bundles."""
+from flask import Flask
 from flask_assets import Bundle, Environment
 
 
-def compile_auth_assets(app):
-    """Generate static assets for the auth views."""
+def compile_stylesheet_assets(app: Flask):
+    """
+    Generate stylesheets for thr application.
+
+    :param Flask app: Parent application to generate styles for.
+    """
     assets = Environment(app)
     Environment.auto_build = True
     Environment.debug = False
     # Stylesheets Bundle
-    less_bundle = Bundle(
+    stylesheet_bundle_account = Bundle(
         "src/less/account.less",
         filters="less,cssmin",
         output="dist/css/account.css",
         extra={"rel": "stylesheet/less"},
     )
-    # JavaScript Bundle
-    js_bundle = Bundle("src/js/main.js", filters="jsmin", output="dist/js/main.min.js")
+    stylesheet_bundle_dashboard = Bundle(
+        "src/less/dashboard.less",
+        filters="less,cssmin",
+        output="dist/css/dashboard.css",
+        extra={"rel": "stylesheet/less"},
+    )
     # Register assets
-    assets.register("less_all", less_bundle)
-    assets.register("js_all", js_bundle)
+    assets.register("styles_account", stylesheet_bundle_account)
+    assets.register("styles_dashboard", stylesheet_bundle_dashboard)
     # Build assets in development mode
     if app.config.get("ENVIRONMENT") != "production":
-        less_bundle.build(force=True)
-        js_bundle.build()
+        stylesheet_bundle_account.build(force=True)
+        stylesheet_bundle_dashboard.build(force=True)
+
 
+def compile_javascript_assets(app: Flask):
+    """
+    Generate static assets for main views.
 
-def compile_main_assets(app):
-    """Generate static assets for main views."""
+    :param Flask app: Parent Flask application to generate Javascript bundles for.
+    """
     assets = Environment(app)
     Environment.auto_build = True
     Environment.debug = False
-    # Stylesheets Bundle
-    less_bundle = Bundle(
-        "src/less/dashboard.less",
-        filters="less,cssmin",
-        output="dist/css/dashboard.css",
-        extra={"rel": "stylesheet/less"},
-    )
+    # JavaScript Bundle
+    js_bundle = Bundle("src/js/main.js", filters="jsmin", output="dist/js/main.min.js")
     # Register assets
-    assets.register("less_all", less_bundle)
+    assets.register("js_all", js_bundle)
     # Build assets in development mode
     if app.config.get("ENVIRONMENT") != "production":
-        less_bundle.build(force=True)
+        js_bundle.build(force=True)
+
 
+def compile_static_assets(app: Flask):
+    """
+    Compile all asset bundles.
 
-def compile_static_assets(app):
-    """Compile all asset bundles."""
-    compile_auth_assets(app)
-    compile_main_assets(app)
+    :param Flask app: Parent Flask application to generate asset bundles for.
+    """
+    compile_stylesheet_assets(app)
+    compile_javascript_assets(app)

flask_session_tutorial/auth.py

@@ -1,5 +1,7 @@
 """Routes for user authentication."""
-from flask import Blueprint, flash, redirect, render_template, request, url_for
+from typing import Optional
+
+from flask import Blueprint, Response, flash, redirect, render_template, request, url_for
 from flask_login import current_user, login_user
 
 from flask_session_tutorial import login_manager
@@ -11,9 +13,10 @@
 
 
 @auth.route("/signup", methods=["GET", "POST"])
-def signup():
+def signup() -> Response:
     """
     Sign-up form to create new user accounts.
+
     GET: Serve sign-up page.
     POST: Validate form, create account, redirect user to dashboard.
     """
@@ -39,15 +42,15 @@ def signup():
 
 
 @auth.route("/login", methods=["GET", "POST"])
-def login():
+def login() -> Response:
     """
     Log-in page for registered users.
+
     GET: Serve Log-in page.
     POST: Validate form and redirect user to dashboard.
     """
     if current_user.is_authenticated:
         return redirect(url_for("main.dashboard"))  # Bypass if user is logged in
-
     form = LoginForm()
     if form.validate_on_submit():
         user = User.query.filter_by(email=form.email.data).first()  # Validate Login Attempt
@@ -67,15 +70,25 @@ def login():
 
 
 @login_manager.user_loader
-def load_user(user_id):
-    """Check if user is logged-in upon page load."""
+def load_user(user_id: int) -> Optional[User]:
+    """
+    Check if user is logged-in upon page load.
+
+    :param int user_id: Primary user ID to load from database, if exists.
+
+    :returns: Optional[User]
+    """
     if user_id is not None:
         return User.query.get(user_id)
     return None
 
 
 @login_manager.unauthorized_handler
-def unauthorized():
-    """Redirect unauthorized users to Login page."""
+def unauthorized() -> Response:
+    """
+    Redirect unauthorized users to Login page.
+
+    :returns: Response
+    """
     flash("You must be logged in to view that page.")
     return redirect(url_for("auth.login"))

flask_session_tutorial/forms.py

@@ -7,35 +7,35 @@
 class SignupForm(FlaskForm):
     """User Sign-up Form."""
 
-    name = StringField("Name", validators=[DataRequired()])
-    email = StringField(
+    user_name = StringField("Name", validators=[DataRequired()])
+    user_email = StringField(
         "Email",
         validators=[
             Length(min=6),
             Email(message="Enter a valid email."),
             DataRequired(),
         ],
     )
-    password = PasswordField(
+    user_password = PasswordField(
         "Password",
         validators=[
             DataRequired(),
             Length(min=6, message="Select a stronger password."),
         ],
     )
-    confirm = PasswordField(
+    user_password_confirm = PasswordField(
         "Confirm Your Password",
         validators=[
             DataRequired(),
             EqualTo("password", message="Passwords must match."),
         ],
     )
-    website = StringField("Website", validators=[Optional()])
-    submit = SubmitField("Register")
+    user_metadata_website = StringField("Website", validators=[Optional()])
+    submit_button = SubmitField("Register")
 
 
 class LoginForm(FlaskForm):
-    """User Log-in Form."""
+    """User Log-in Form for existing users."""
 
     email = StringField("Email", validators=[DataRequired(), Email(message="Enter a valid email.")])
     password = PasswordField("Password", validators=[DataRequired()])