Updated README, formatting.

Author: toddbirchard

Makefile

@@ -12,10 +12,11 @@ make clean      - Remove cached files and lock files.
 endef
 export HELP
 
-.PHONY: run restart deploy update clean help
+.PHONY: run deploy update format clean help
 
 
 requirements: .requirements.txt
+env: .venv/bin/activate
 
 
 .requirements.txt: requirements.txt
@@ -27,8 +28,8 @@ all help:
 
 
 .PHONY: run
-run:
-	$(shell . .venv/bin/activate && python3 wsgi.py)
+run: env
+	$(shell . .venv/bin/activate && flask run)
 
 
 .PHONY: deploy
@@ -37,17 +38,16 @@ deploy:
 
 
 .PHONY: update
-update:
-	poetry shell && poetry update
-	pip freeze > requirements.txt
-	exit
+update: env
+	.venv/bin/python3 -m pip install -U pip
+	poetry update
+	poetry export -f requirements.txt --output requirements.txt --without-hashes
 
 
 .PHONY: format
-format: requirements
-	$(shell . .venv/bin/activate)
-	$(shell isort -rc ./)
-	$(shell black ./)
+format: env
+	$(shell . .venv/bin/activate && isort -rc ./)
+	$(shell . .venv/bin/activate && black ./)
 
 
 .PHONY: clean

Pipfile

@@ -16,59 +16,39 @@
 
 ![Flask Session Redis Tutorial](https://github.com/hackersandslackers/flask-session-tutorial/blob/master/.github/flask-session2@2x.jpg?raw=true)
 
-Source code for the accompanying tutorial found here: 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/
 
+# Getting Started
 
-## Installation
+Get set up locally in two steps:
 
-**Installation via `requirements.txt`**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/flask-session-tutorial.git
-$ cd flask-session-tutorial
-$ python3 -m venv myenv
-$ source myenv/bin/activate
-$ pip3 install -r requirements.txt
-$ flask run
-```
-
-**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/flask-session-tutorial.git
-$ cd flask-session-tutorial
-$ pipenv shell
-$ pipenv update
-$ flask run
-```
-
-**Installation via [Poetry](https://python-poetry.org/)**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/flask-session-tutorial.git
-$ cd flask-session-tutorial
-$ poetry shell
-$ poetry update
-$ poetry run
-```
-
-## Usage
+### Environment Variables
 
 Replace the values in **.env.example** with your values and rename this file to **.env**:
 
-* `FLASK_APP`: Entry point of your application (should be `wsgi.py`).
-* `FLASK_ENV`: The environment to run your app in (either `development` or `production`).
+* `FLASK_APP`: Entry point of your application; should be `wsgi.py`.
+* `FLASK_ENV`: The environment in which to run your application; either `development` or `production`.
 * `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.
-* `LESS_BIN`: Path to your local LESS installation via `which lessc` (optional for static assets).
-* `ASSETS_DEBUG`: Debug asset creation and bundling in `development` (optional).
-* `LESS_RUN_IN_DEBUG`: Debug LESS while in `development` (optional).
-* `COMPRESSOR_DEBUG`: Debug asset compression while in `development` (optional).
+* `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`.
+* `COMPRESSOR_DEBUG` *(optional)*: Debug asset compression while in `development`.
 
 
 *Remember never to commit secrets saved in .env files to Github.*
 
+### Installation
+
+Get up and running with `make deploy`:
+
+```shell
+$ git clone https://github.com/hackersandslackers/flask-session-tutorial.git
+$ cd flask-session-tutorial
+$ make deploy
+``` 
+
 -----
 
-**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.
+**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.

Pipfile.lock

@@ -5,33 +5,33 @@
 from dotenv import load_dotenv
 
 basedir = path.abspath(path.dirname(__file__))
-load_dotenv(path.join(basedir, '.env'))
+load_dotenv(path.join(basedir, ".env"))
 
 
 class Config:
     """Set Flask configuration variables from .env file."""
 
     # General Config
-    FLASK_APP = environ.get('FLASK_APP')
-    FLASK_ENV = environ.get('FLASK_ENV')
-    SECRET_KEY = environ.get('SECRET_KEY')
+    FLASK_APP = environ.get("FLASK_APP")
+    FLASK_ENV = environ.get("FLASK_ENV")
+    SECRET_KEY = environ.get("SECRET_KEY")
 
     # Flask-Session
-    REDIS_URI = environ.get('SESSION_REDIS')
-    SESSION_TYPE = 'redis'
+    REDIS_URI = environ.get("SESSION_REDIS")
+    SESSION_TYPE = "redis"
     SESSION_REDIS = redis.from_url(REDIS_URI)
 
     # Flask-Assets
-    LESS_BIN = environ.get('LESS_BIN')
+    LESS_BIN = environ.get("LESS_BIN")
     ASSETS_DEBUG = False
     LESS_RUN_IN_DEBUG = False
 
     # Static Assets
-    STATIC_FOLDER = 'static'
-    TEMPLATES_FOLDER = 'templates'
+    STATIC_FOLDER = "static"
+    TEMPLATES_FOLDER = "templates"
     COMPRESSOR_DEBUG = True
 
     # Flask-SQLAlchemy
-    SQLALCHEMY_DATABASE_URI = environ.get('SQLALCHEMY_DATABASE_URI')
+    SQLALCHEMY_DATABASE_URI = environ.get("SQLALCHEMY_DATABASE_URI")
     SQLALCHEMY_TRACK_MODIFICATIONS = False
     SQLALCHEMY_ECHO = True

README.md

@@ -12,7 +12,7 @@
 def create_app():
     """Construct the core flask_session_tutorial."""
     app = Flask(__name__, instance_relative_config=False)
-    app.config.from_object('config.Config')
+    app.config.from_object("config.Config")
 
     # Initialize Plugins
     db.init_app(app)
@@ -23,6 +23,7 @@ def create_app():
         from . import routes
         from . import auth
         from .assets import compile_static_assets, compile_auth_assets
+
         app.register_blueprint(routes.main_bp)
         app.register_blueprint(auth.auth_bp)
 

config.py

@@ -9,22 +9,18 @@ def compile_auth_assets(app):
     Environment.debug = False
     # Stylesheets Bundle
     less_bundle = Bundle(
-        'src/less/account.less',
-        filters='less,cssmin',
-        output='dist/css/account.css',
-        extra={'rel': 'stylesheet/less'}
+        "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'
-    )
+    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)
+    assets.register("less_all", less_bundle)
+    assets.register("js_all", js_bundle)
     # Build assets in development mode
-    if app.config['FLASK_ENV'] != 'production':
+    if app.config["FLASK_ENV"] != "production":
         less_bundle.build(force=True)
         js_bundle.build()
 
@@ -36,15 +32,15 @@ def compile_main_assets(app):
     Environment.debug = False
     # Stylesheets Bundle
     less_bundle = Bundle(
-        'src/less/dashboard.less',
-        filters='less,cssmin',
-        output='dist/css/dashboard.css',
-        extra={'rel': 'stylesheet/less'}
+        "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("less_all", less_bundle)
     # Build assets in development mode
-    if app.config['FLASK_ENV'] != 'production':
+    if app.config["FLASK_ENV"] != "production":
         less_bundle.build(force=True)
 
 

flask_session_tutorial/__init__.py

@@ -11,13 +11,11 @@
 
 # Blueprint Configuration
 auth_bp = Blueprint(
-    'auth_bp', __name__,
-    template_folder='templates',
-    static_folder='static'
+    "auth_bp", __name__, template_folder="templates", static_folder="static"
 )
 
 
-@auth_bp.route('/signup', methods=['GET', 'POST'])
+@auth_bp.route("/signup", methods=["GET", "POST"])
 def signup():
     """
     Sign-up form to create new user accounts.
@@ -29,51 +27,51 @@ def signup():
         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
+                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'))
-        flash('A user already exists with that email address.')
+            return redirect(url_for("main_bp.dashboard"))
+        flash("A user already exists with that email address.")
     return render_template(
-        'signup.jinja2',
-        title='Create an Account.',
+        "signup.jinja2",
+        title="Create an Account.",
         form=form,
-        template='signup-page',
-        body="Sign up for a user account."
+        template="signup-page",
+        body="Sign up for a user account.",
     )
 
 
-@auth_bp.route('/login', methods=['GET', 'POST'])
+@auth_bp.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_bp.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'))
-        flash('Invalid username/password combination')
-        return redirect(url_for('auth_bp.login'))
+            next_page = request.args.get("next")
+            return redirect(next_page or url_for("main_bp.dashboard"))
+        flash("Invalid username/password combination")
+        return redirect(url_for("auth_bp.login"))
     return render_template(
-        'login.jinja2',
+        "login.jinja2",
         form=form,
-        title='Log in.',
-        template='login-page',
-        body="Log in with your User account."
+        title="Log in.",
+        template="login-page",
+        body="Log in with your User account.",
     )
 
 
@@ -88,5 +86,5 @@ def load_user(user_id):
 @login_manager.unauthorized_handler
 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'))
+    flash("You must be logged in to view that page.")
+    return redirect(url_for("auth_bp.login"))