Added Makefile.

Author: toddbirchard

Makefile

@@ -0,0 +1,58 @@
+SRCPATH := $(CURDIR)
+PROJECTNAME := $(shell basename $(CURDIR))
+
+define HELP
+Manage $(PROJECTNAME). Usage:
+
+make run        - Run $(PROJECTNAME).
+make deploy     - Install requirements and run app for the first time.
+make update     - Update pip dependencies via Python Poetry.
+make format     - Format code with Python's `Black` library.
+make clean      - Remove cached files and lock files.
+endef
+export HELP
+
+.PHONY: run restart deploy update clean help
+
+
+requirements: .requirements.txt
+
+
+.requirements.txt: requirements.txt
+	$(shell . .venv/bin/activate && pip install -r requirements.txt)
+
+
+all help:
+	@echo "$$HELP"
+
+
+.PHONY: run
+run:
+	$(shell . .venv/bin/activate && python3 wsgi.py)
+
+
+.PHONY: deploy
+deploy:
+	$(shell . ./deploy.sh)
+
+
+.PHONY: update
+update:
+	poetry shell && poetry update
+	pip freeze > requirements.txt
+	exit
+
+
+.PHONY: format
+format: requirements
+	$(shell . .venv/bin/activate)
+	$(shell isort -rc ./)
+	$(shell black ./)
+
+
+.PHONY: clean
+clean:
+	find . -name '*.pyc' -delete
+	find . -name '__pycache__' -delete
+	find . -name 'poetry.lock' -delete
+	find . -name 'Pipefile.lock' -delete

README.md

@@ -4,7 +4,7 @@
 ![Flask](https://img.shields.io/badge/Flask-v^1.1.1-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.5.0-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.3.1-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.3.2-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.3.2-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-v0.9.3-red.svg?longCache=true&style=flat-square&logo=scala&logoColor=white&colorA=4c566a&colorB=bf616a)

config.py

@@ -1,7 +1,8 @@
 """App configuration."""
 from os import environ, path
-from dotenv import load_dotenv
+
 import redis
+from dotenv import load_dotenv
 
 basedir = path.abspath(path.dirname(__file__))
 load_dotenv(path.join(basedir, '.env'))

deploy.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+if [ -d ".venv" ]
+then
+    source .venv/bin/activate
+    pip install -r requirements.txt
+    python3 wsgi.py
+else
+    python3 -m venv .venv
+    source .venv/bin/activate
+    python3 -m pip install --upgrade pip
+    pip install -r requirements.txt
+    python3 wsgi.py
+fi

flask_session_tutorial/__init__.py

@@ -1,9 +1,8 @@
 """Initialize app."""
 from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
 from flask_login import LoginManager
 from flask_session import Session
-
+from flask_sqlalchemy import SQLAlchemy
 
 db = SQLAlchemy()
 login_manager = LoginManager()

flask_session_tutorial/assets.py

@@ -1,5 +1,5 @@
 """Compile static asset bundles."""
-from flask_assets import Environment, Bundle
+from flask_assets import Bundle, Environment
 
 
 def compile_auth_assets(app):
@@ -24,7 +24,7 @@ def compile_auth_assets(app):
     assets.register('less_all', less_bundle)
     assets.register('js_all', js_bundle)
     # Build assets in development mode
-    if app.config['FLASK_ENV'] == 'development':
+    if app.config['FLASK_ENV'] != 'production':
         less_bundle.build(force=True)
         js_bundle.build()
 
@@ -44,7 +44,7 @@ def compile_main_assets(app):
     # Register assets
     assets.register('less_all', less_bundle)
     # Build assets in development mode
-    if app.config['FLASK_ENV'] == 'development':
+    if app.config['FLASK_ENV'] != 'production':
         less_bundle.build(force=True)
 
 

flask_session_tutorial/auth.py

@@ -1,12 +1,13 @@
 """Routes for user authentication."""
-from flask import redirect, render_template, flash, Blueprint, request, url_for
-from flask_login import current_user, login_user
+from flask import Blueprint
 from flask import current_app as app
+from flask import 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 db, User
-from .import login_manager
-
+from .models import User, db
 
 # Blueprint Configuration
 auth_bp = Blueprint(
@@ -88,4 +89,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_bp.login'))

flask_session_tutorial/forms.py

@@ -1,6 +1,6 @@
 """Sign-up & log-in forms."""
 from flask_wtf import FlaskForm
-from wtforms import StringField, PasswordField, SubmitField
+from wtforms import PasswordField, StringField, SubmitField
 from wtforms.validators import DataRequired, Email, EqualTo, Length, Optional
 
 
@@ -48,4 +48,4 @@ class LoginForm(FlaskForm):
         ]
     )
     password = PasswordField('Password', validators=[DataRequired()])
-    submit = SubmitField('Log In')
+    submit = SubmitField('Log In')

flask_session_tutorial/models.py

@@ -1,7 +1,8 @@
 """Database models."""
-from . import db
 from flask_login import UserMixin
-from werkzeug.security import generate_password_hash, check_password_hash
+from werkzeug.security import check_password_hash, generate_password_hash
+
+from . import db
 
 
 class User(UserMixin, db.Model):

flask_session_tutorial/routes.py

@@ -1,10 +1,10 @@
 """Routes for logged-in flask_session_tutorial."""
-from flask import Blueprint, render_template, redirect, url_for, session
-from flask_login import current_user, logout_user
+from flask import Blueprint
 from flask import current_app as app
-from .assets import compile_auth_assets
-from flask_login import login_required
+from flask import redirect, render_template, session, url_for
+from flask_login import current_user, login_required, logout_user
 
+from .assets import compile_auth_assets
 
 # Blueprint Configuration
 main_bp = Blueprint(
@@ -44,4 +44,4 @@ def session_view():
 def logout():
     """User log-out logic."""
     logout_user()
-    return redirect(url_for('auth_bp.login'))
+    return redirect(url_for('auth_bp.login'))