Minor cleanup.

Author: toddbirchard

Makefile

@@ -36,7 +36,7 @@ $(VIRTUAL_ENV):
 
 .PHONY: run
 run: env
-	export LESS_BIN=$(shell which lessc)
+	export LESS_BIN=$(shell which lessc) && \
 	uwsgi --http 127.0.0.1:8082 --master --module wsgi:app --processes 4 --threads 2
 
 
@@ -75,7 +75,7 @@ update: env
 
 .PHONY: format
 format: env
-	$(LOCAL_PYTHON) -m isort --multi-line=3 .
+	$(LOCAL_PYTHON) -m isort --multi-line=3 . && \
 	$(LOCAL_PYTHON) -m black .
 
 

README.md

@@ -3,20 +3,16 @@
 ![Python](https://img.shields.io/badge/Python-v^3.9-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
 ![Flask](https://img.shields.io/badge/Flask-v^2.2.2-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![Flask-Login](https://img.shields.io/badge/Flask--Login-v0.6.2-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Flask-Assets](https://img.shields.io/badge/Flask--Assets-v2.0-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![Flask-Session](https://img.shields.io/badge/Flask--Session-v0.4.0-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Flask-SQLAlchemy](https://img.shields.io/badge/Flask--SQLAlchemy-v2.5.1-red.svg?longCache=true&style=flat-square&logo=flask&logoColor=white&colorA=4c566a&colorB=5e81ac)
-![WTForms](https://img.shields.io/badge/WTForms-v2.2.1-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![PyMySQL](https://img.shields.io/badge/PyMySQL-v1.0.2-red.svg?longCache=true&style=flat-square&logo=scala&logoColor=white&colorA=4c566a&colorB=bf616a)
-![Redis](https://img.shields.io/badge/Redis-v4.2.2-red.svg?longCache=true&style=flat-square&logo=redis&logoColor=white&colorA=4c566a&colorB=bf616a)
+![Redis](https://img.shields.io/badge/Redis-v4.4.2-red.svg?longCache=true&style=flat-square&logo=redis&logoColor=white&colorA=4c566a&colorB=bf616a)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c&logo=GitHub)
 [![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/flask-session-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-session-tutorial/issues)
 [![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/flask-session-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-session-tutorial/stargazers)
 [![GitHub Forks](https://img.shields.io/github/forks/hackersandslackers/flask-session-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-session-tutorial/network)
 
 ![Flask Session Redis Tutorial](https://github.com/hackersandslackers/flask-session-tutorial/blob/master/.github/flask-session2@2x.jpg?raw=true)
 
-**Tutorial**: https://hackersandslackers.com/managing-user-session-variables-with-flask-sessions-and-redis/
+**Tutorial**: [https://hackersandslackers.com/managing-user-session-variables-with-flask-sessions-and-redis/](https://hackersandslackers.com/managing-user-session-variables-with-flask-sessions-and-redis/)
 
 ## Getting Started
 

config.py

@@ -18,7 +18,7 @@ class Config:
     SECRET_KEY = environ.get("SECRET_KEY")
 
     # Flask-Session
-    REDIS_URI = environ.get("SESSION_REDIS")
+    REDIS_URI = environ.get("REDIS_URI")
     SESSION_TYPE = "redis"
     SESSION_REDIS = redis.from_url(REDIS_URI)
 

flask_session_tutorial/__init__.py

@@ -4,10 +4,9 @@
 from flask_session import Session
 from flask_sqlalchemy import SQLAlchemy
 
-
 db = SQLAlchemy()
 login_manager = LoginManager()
-sess = Session()
+session = Session()
 
 
 def create_app():
@@ -18,15 +17,14 @@ def create_app():
     # Initialize Plugins
     db.init_app(app)
     login_manager.init_app(app)
-    sess.init_app(app)
+    session.init_app(app)
 
     with app.app_context():
-        from . import routes
-        from . import auth
-        from .assets import compile_static_assets, compile_auth_assets
+        from . import auth, routes
+        from .assets import compile_auth_assets, compile_static_assets
 
-        app.register_blueprint(routes.main_bp)
-        app.register_blueprint(auth.auth_bp)
+        app.register_blueprint(routes.main)
+        app.register_blueprint(auth.auth)
 
         # Create static asset bundles
         compile_static_assets(app)

flask_session_tutorial/assets.py

@@ -3,7 +3,7 @@
 
 
 def compile_auth_assets(app):
-    """Configure authorization asset bundles."""
+    """Generate static assets for the auth views."""
     assets = Environment(app)
     Environment.auto_build = True
     Environment.debug = False
@@ -26,7 +26,7 @@ def compile_auth_assets(app):
 
 
 def compile_main_assets(app):
-    """Configure logged-in asset bundles."""
+    """Generate static assets for main views."""
     assets = Environment(app)
     Environment.auto_build = True
     Environment.debug = False

flask_session_tutorial/auth.py

@@ -1,21 +1,16 @@
 """Routes for user authentication."""
-from flask import Blueprint
-from flask import current_app as app
-from flask import flash, redirect, render_template, request, url_for
+from flask import Blueprint, flash, redirect, render_template, request, url_for
 from flask_login import current_user, login_user
 
-from . import login_manager
-from .assets import compile_auth_assets
-from .forms import LoginForm, SignupForm
-from .models import User, db
+from flask_session_tutorial import login_manager
+from flask_session_tutorial.forms import LoginForm, SignupForm
+from flask_session_tutorial.models import User, db
 
 # Blueprint Configuration
-auth_bp = Blueprint(
-    "auth_bp", __name__, template_folder="templates", static_folder="static"
-)
+auth = Blueprint("auth", __name__, template_folder="templates", static_folder="static")
 
 
-@auth_bp.route("/signup", methods=["GET", "POST"])
+@auth.route("/signup", methods=["GET", "POST"])
 def signup():
     """
     Sign-up form to create new user accounts.
@@ -26,15 +21,13 @@ def signup():
     if form.validate_on_submit():
         existing_user = User.query.filter_by(email=form.email.data).first()
         if existing_user is None:
-            user = User(
-                name=form.name.data, email=form.email.data, website=form.website.data
-            )
+            user = User(name=form.name.data, email=form.email.data, website=form.website.data)
             user.set_password(form.password.data)
             db.session.add(user)
             db.session.commit()  # Create new user
             login_user(user)  # Log in as newly created user
             print(user)
-            return redirect(url_for("main_bp.dashboard"))
+            return redirect(url_for("main.dashboard"))
         flash("A user already exists with that email address.")
     return render_template(
         "signup.jinja2",
@@ -45,27 +38,25 @@ def signup():
     )
 
 
-@auth_bp.route("/login", methods=["GET", "POST"])
+@auth.route("/login", methods=["GET", "POST"])
 def login():
     """
     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_bp.dashboard"))  # Bypass if user is logged in
+        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
+        user = User.query.filter_by(email=form.email.data).first()  # Validate Login Attempt
         if user and user.check_password(password=form.password.data):
             login_user(user)
             next_page = request.args.get("next")
-            return redirect(next_page or url_for("main_bp.dashboard"))
+            return redirect(next_page or url_for("main.dashboard"))
         flash("Invalid username/password combination")
-        return redirect(url_for("auth_bp.login"))
+        return redirect(url_for("auth.login"))
     return render_template(
         "login.jinja2",
         form=form,
@@ -87,4 +78,4 @@ def load_user(user_id):
 def unauthorized():
     """Redirect unauthorized users to Login page."""
     flash("You must be logged in to view that page.")
-    return redirect(url_for("auth_bp.login"))
+    return redirect(url_for("auth.login"))

flask_session_tutorial/forms.py

@@ -37,8 +37,6 @@ class SignupForm(FlaskForm):
 class LoginForm(FlaskForm):
     """User Log-in Form."""
 
-    email = StringField(
-        "Email", validators=[DataRequired(), Email(message="Enter a valid email.")]
-    )
+    email = StringField("Email", validators=[DataRequired(), Email(message="Enter a valid email.")])
     password = PasswordField("Password", validators=[DataRequired()])
     submit = SubmitField("Log In")

flask_session_tutorial/models.py

@@ -2,7 +2,7 @@
 from flask_login import UserMixin
 from werkzeug.security import check_password_hash, generate_password_hash
 
-from . import db
+from flask_session_tutorial import db
 
 
 class User(UserMixin, db.Model):
@@ -12,9 +12,7 @@ class User(UserMixin, db.Model):
     id = db.Column(db.Integer, primary_key=True)
     name = db.Column(db.String(200), nullable=False, unique=False)
     email = db.Column(db.String(40), unique=True, nullable=False)
-    password = db.Column(
-        db.String(200), primary_key=False, unique=False, nullable=False
-    )
+    password = db.Column(db.String(200), primary_key=False, unique=False, nullable=False)
     website = db.Column(db.String(60), index=False, unique=False, nullable=True)
     created_on = db.Column(db.DateTime, index=False, unique=False, nullable=True)
     last_login = db.Column(db.DateTime, index=False, unique=False, nullable=True)

flask_session_tutorial/routes.py

@@ -7,12 +7,10 @@
 from .assets import compile_auth_assets
 
 # Blueprint Configuration
-main_bp = Blueprint(
-    "main_bp", __name__, template_folder="templates", static_folder="static"
-)
+main = Blueprint("main", __name__, template_folder="templates", static_folder="static")
 
 
-@main_bp.route("/", methods=["GET"])
+@main.route("/", methods=["GET"])
 @login_required
 def dashboard():
     """Logged in Dashboard screen."""
@@ -26,7 +24,7 @@ def dashboard():
     )
 
 
-@main_bp.route("/session", methods=["GET"])
+@main.route("/session", methods=["GET"])
 @login_required
 def session_view():
     """Display session variable value."""
@@ -38,9 +36,9 @@ def session_view():
     )
 
 
-@main_bp.route("/logout")
+@main.route("/logout")
 @login_required
 def logout():
     """User log-out logic."""
     logout_user()
-    return redirect(url_for("auth_bp.login"))
+    return redirect(url_for("auth.login"))

flask_session_tutorial/templates/dashboard.jinja2

@@ -7,7 +7,7 @@
 
 {% block nav %}
     <nav style="position:absolute; top:20px; right:20px;">
-        <a href="{{ url_for('main_bp.session_view') }}" style="color:white">Session test</a>
+        <a href="{{ url_for('main.session_view') }}" style="color:white">Session test</a>
     </nav>
 {% endblock %}
 
@@ -16,6 +16,6 @@
 
     {% if current_user.is_authenticated %}
         <p>Hi {{ current_user.name }}!</p>
-        <a href="{{ url_for('main_bp.logout') }}">Log out</a>
+        <a href="{{ url_for('main.logout') }}">Log out</a>
     {% endif %}
 {% endblock %}