Refactor flask-assets.

Author: toddbirchard

.env.example

@@ -2,7 +2,7 @@ ENVIRONMENT=production
 FLASK_DEBUG=True
 SECRET_KEY=YourSecretKey
 
-REDIS_URI=redis://:password@host.com:1234
+REDIS_URI="redis://:password@host.com:1234"
 
 SQLALCHEMY_DATABASE_URI=mysql+pymysql://myuser:mypassword@host.example.com:1234/mydatabase
 SQLALCHEMY_CA_CERTS="./creds/certificate.crt"

config.py

@@ -1,6 +1,7 @@
 """App configuration."""
-from os import environ, path
+
 import subprocess
+from os import environ, path
 
 import redis
 from dotenv import load_dotenv

flask_session_tutorial/__init__.py

@@ -1,33 +1,39 @@
 """Initialize app."""
+
 from flask import Flask
+from flask_assets import Environment
 from flask_login import LoginManager
 from flask_session import Session
 from flask_sqlalchemy import SQLAlchemy
 
 db = SQLAlchemy()
 login_manager = LoginManager()
 session = Session()
+assets = Environment()
 
 
 def create_app():
     """Construct the core flask_session_tutorial."""
     app = Flask(__name__, instance_relative_config=False)
     app.config.from_object("config.Config")
+    assets = Environment()
 
     # Initialize Plugins
     db.init_app(app)
     login_manager.init_app(app)
     session.init_app(app)
+    assets.init_app(app)
 
     with app.app_context():
         from . import auth, routes
-        from .assets import compile_static_assets
+        from .assets import compile_javascript, compile_stylesheets
 
         app.register_blueprint(routes.main_blueprint)
         app.register_blueprint(auth.auth_blueprint)
 
         # Create static asset bundles
-        compile_static_assets(app)
+        compile_stylesheets(assets)
+        compile_javascript(assets)
 
         # Create Database Models
         db.create_all()

flask_session_tutorial/assets.py

@@ -1,50 +1,41 @@
 """Compile static asset bundles."""
-from flask import Flask
-from flask_assets import Bundle, Environment
-
-
-def compile_static_assets(app: Flask):
-    """
-    Compile all asset bundles.
 
-    :param Flask app: Top-level Flask application.
-    """
-    compile_stylesheets(app)
-    compile_javascript(app)
+from flask import current_app as app
+from flask_assets import Bundle, Environment
 
 
-def compile_stylesheets(app: Flask):
+def compile_stylesheets(assets: Environment) -> Environment:
     """
     Generate CSS from .LESS source.
 
     :param Flask app: Top-level Flask application.
     """
-    assets = Environment(app)
     Environment.auto_build = True
     Environment.debug = False
     # Stylesheets Bundle
-    stylesheet_bundle_account = Bundle(
+    account_stylesheet_bundle = Bundle(
         "src/less/account.less",
         filters="less,cssmin",
         output="dist/css/account.css",
         extra={"rel": "stylesheet/less"},
     )
-    stylesheet_bundle_dashboard = Bundle(
+    dashboard_stylesheet_bundle = Bundle(
         "src/less/dashboard.less",
         filters="less,cssmin",
         output="dist/css/dashboard.css",
         extra={"rel": "stylesheet/less"},
     )
     # Register assets
-    assets.register("styles_account", stylesheet_bundle_account)
-    assets.register("styles_dashboard", stylesheet_bundle_dashboard)
+    assets.register("styles_account", account_stylesheet_bundle)
+    assets.register("styles_dashboard", dashboard_stylesheet_bundle)
     # Build assets in development mode
     if app.config.get("ENVIRONMENT") != "production":
-        stylesheet_bundle_account.build(force=True)
-        stylesheet_bundle_dashboard.build(force=True)
+        account_stylesheet_bundle.build(force=True)
+        dashboard_stylesheet_bundle.build(force=True)
+    return assets
 
 
-def compile_javascript(app: Flask):
+def compile_javascript(assets: Environment) -> Environment:
     """
     Bundle and minimize Javascript source files.
 
@@ -60,3 +51,4 @@ def compile_javascript(app: Flask):
     # Build assets in development mode
     if app.config.get("ENVIRONMENT") != "production":
         js_bundle.build(force=True)
+    return assets

flask_session_tutorial/auth.py

@@ -1,4 +1,5 @@
 """Routes for user authentication."""
+
 from typing import Optional
 
 from flask import Blueprint, Response, flash, redirect, render_template, request, url_for

flask_session_tutorial/forms.py

@@ -1,4 +1,5 @@
 """Sign-up & log-in forms."""
+
 from flask_wtf import FlaskForm
 from wtforms import PasswordField, StringField, SubmitField
 from wtforms.validators import DataRequired, Email, EqualTo, Length, Optional

flask_session_tutorial/models.py

@@ -1,4 +1,5 @@
 """Database models."""
+
 from flask_login import UserMixin
 from werkzeug.security import check_password_hash, generate_password_hash
 

flask_session_tutorial/routes.py

@@ -1,4 +1,5 @@
 """Routes for logged-in flask_session_tutorial."""
+
 from flask import Blueprint, Response, redirect, render_template, session, url_for
 from flask_login import current_user, login_required, logout_user
 

flask_session_tutorial/static/src/less/dashboard.less

@@ -29,6 +29,11 @@ html {
     margin: auto;
     height: fit-content;
 
+    @media(max-width: @mobile-breakpoint) {
+      width: 100%;
+      margin: 0;
+    }
+
     h1 {
       font-family: 'agenda', sans-serif;
       font-weight: 600;

flask_session_tutorial/static/src/less/vars.less

@@ -23,3 +23,7 @@
 
 // Animation
 @transition: all .3s ease-out;
+
+// Breakpoints
+@tablet-breakpoint: 800px;
+@mobile-breakpoint: 600px;

gunicorn.conf.py

@@ -1,4 +1,5 @@
 """Gunicorn configuration file."""
+
 from os import environ, path
 
 from dotenv import load_dotenv

poetry.lock

@@ -39,7 +39,7 @@ run = "wsgi:app"
 issues = "https://github.com/hackersandslackers/flask-session-tutorial/issues"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["poetry-core>=1.5.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.pylint.'MESSAGES CONTROL']

pyproject.toml

@@ -1,42 +1,43 @@
-async-timeout==4.0.3 ; python_version >= "3.10" and python_full_version <= "3.11.2"
-black==23.12.1 ; python_version >= "3.10" and python_version < "4.0"
+async-timeout==4.0.3 ; python_version >= "3.10" and python_full_version < "3.11.3"
+black==24.4.0 ; python_version >= "3.10" and python_version < "4.0"
 blinker==1.7.0 ; python_version >= "3.10" and python_version < "4.0"
-cachelib==0.10.2 ; python_version >= "3.10" and python_version < "4.0"
+cachelib==0.13.0 ; python_version >= "3.10" and python_version < "4.0"
 click==8.1.7 ; python_version >= "3.10" and python_version < "4.0"
 colorama==0.4.6 ; python_version >= "3.10" and python_version < "4.0" and platform_system == "Windows"
 cssmin==0.2.0 ; python_version >= "3.10" and python_version < "4.0"
-dnspython==2.4.2 ; python_version >= "3.10" and python_version < "4.0"
-email-validator==2.1.0.post1 ; python_version >= "3.10" and python_version < "4.0"
+dnspython==2.6.1 ; python_version >= "3.10" and python_version < "4.0"
+email-validator==2.1.1 ; python_version >= "3.10" and python_version < "4.0"
 flake8==7.0.0 ; python_version >= "3.10" and python_version < "4.0"
 flask-assets==2.1.0 ; python_version >= "3.10" and python_version < "4.0"
 flask-login==0.6.3 ; python_version >= "3.10" and python_version < "4.0"
-flask-session==0.5.0 ; python_version >= "3.10" and python_version < "4.0"
+flask-session==0.8.0 ; python_version >= "3.10" and python_version < "4.0"
 flask-sqlalchemy==3.1.1 ; python_version >= "3.10" and python_version < "4.0"
 flask-wtf==1.2.1 ; python_version >= "3.10" and python_version < "4.0"
-flask==3.0.0 ; python_version >= "3.10" and python_version < "4.0"
+flask==3.0.3 ; python_version >= "3.10" and python_version < "4.0"
 greenlet==3.0.3 ; python_version >= "3.10" and python_version < "4.0" and (platform_machine == "aarch64" or platform_machine == "ppc64le" or platform_machine == "x86_64" or platform_machine == "amd64" or platform_machine == "AMD64" or platform_machine == "win32" or platform_machine == "WIN32")
 gunicorn==21.2.0 ; python_version >= "3.10" and python_version < "4.0"
-idna==3.6 ; python_version >= "3.10" and python_version < "4.0"
+idna==3.7 ; python_version >= "3.10" and python_version < "4.0"
 isort==5.13.2 ; python_version >= "3.10" and python_version < "4.0"
 itsdangerous==2.1.2 ; python_version >= "3.10" and python_version < "4.0"
-jinja2==3.1.2 ; python_version >= "3.10" and python_version < "4.0"
+jinja2==3.1.3 ; python_version >= "3.10" and python_version < "4.0"
 jsmin==3.0.1 ; python_version >= "3.10" and python_version < "4.0"
 lesscpy==0.15.1 ; python_version >= "3.10" and python_version < "4.0"
-markupsafe==2.1.3 ; python_version >= "3.10" and python_version < "4.0"
+markupsafe==2.1.5 ; python_version >= "3.10" and python_version < "4.0"
 mccabe==0.7.0 ; python_version >= "3.10" and python_version < "4.0"
+msgspec==0.18.6 ; python_version >= "3.10" and python_version < "4.0"
 mypy-extensions==1.0.0 ; python_version >= "3.10" and python_version < "4.0"
-packaging==23.2 ; python_version >= "3.10" and python_version < "4.0"
+packaging==24.0 ; python_version >= "3.10" and python_version < "4.0"
 pathspec==0.12.1 ; python_version >= "3.10" and python_version < "4.0"
-platformdirs==4.1.0 ; python_version >= "3.10" and python_version < "4.0"
+platformdirs==4.2.0 ; python_version >= "3.10" and python_version < "4.0"
 ply==3.11 ; python_version >= "3.10" and python_version < "4.0"
 pycodestyle==2.11.1 ; python_version >= "3.10" and python_version < "4.0"
 pyflakes==3.2.0 ; python_version >= "3.10" and python_version < "4.0"
 pymysql==1.1.0 ; python_version >= "3.10" and python_version < "4.0"
-python-dotenv==1.0.0 ; python_version >= "3.10" and python_version < "4.0"
-redis==5.0.1 ; python_version >= "3.10" and python_version < "4.0"
-sqlalchemy==2.0.25 ; python_version >= "3.10" and python_version < "4.0"
+python-dotenv==1.0.1 ; python_version >= "3.10" and python_version < "4.0"
+redis==5.0.3 ; python_version >= "3.10" and python_version < "4.0"
+sqlalchemy==2.0.29 ; python_version >= "3.10" and python_version < "4.0"
 tomli==2.0.1 ; python_version >= "3.10" and python_version < "3.11"
-typing-extensions==4.9.0 ; python_version >= "3.10" and python_version < "4.0"
+typing-extensions==4.11.0 ; python_version >= "3.10" and python_version < "4.0"
 webassets==2.0 ; python_version >= "3.10" and python_version < "4.0"
-werkzeug==3.0.1 ; python_version >= "3.10" and python_version < "4.0"
+werkzeug==3.0.2 ; python_version >= "3.10" and python_version < "4.0"
 wtforms==3.1.2 ; python_version >= "3.10" and python_version < "4.0"

requirements.txt

@@ -1,4 +1,5 @@
 """App entry point."""
+
 from flask_session_tutorial import create_app
 
 app = create_app()