Bump dependencies.

Author: toddbirchard

.env.example

@@ -1,3 +1,4 @@
-FLASK_ENV=production
+ENVIRONMENT=production
+FLASK_DEBUG=False
 SECRET_KEY=YOURSECRETKEY
 SQLALCHEMY_DATABASE_URI=mysql+pymysql://[USER]:[PASSWORD]@[HOST]:[PORT]/[DATABASE_NAME]

.flake8

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

Makefile

@@ -1,89 +1,93 @@
 PROJECT_NAME := $(shell basename $CURDIR)
-VIRTUAL_ENVIRONMENT := $(CURDIR)/.venv
-LOCAL_PYTHON := $(VIRTUAL_ENVIRONMENT)/bin/python3
+VIRTUAL_ENV := $(CURDIR)/.venv
+LOCAL_PYTHON := $(VIRTUAL_ENV)/bin/python3
 
 define HELP
 Manage $(PROJECT_NAME). Usage:
 
-make run        - Run $(PROJECT_NAME).
-make install    - Create virtual env, install dependencies, and run project.
-make deploy     - Install and run script by running `make install` and `make run` in succession.
-make update     - Update pip dependencies via Poetry and export output to requirements.txt.
-make format     - Format code with Pythons `Black` library.
-make lint       - Check code formatting with `flake8`.
-make clean      - Remove cached files and lock files.
+make run        - Run $(PROJECT_NAME) locally.
+make install    - Create local virtualenv & install dependencies.
+make deploy     - Set up project & run locally.
+make update     - Update dependencies via Poetry and output resulting `requirements.txt`.
+make format     - Run Python code formatter & sort dependencies.
+make lint       - Check code formatting with flake8.
+make clean      - Remove extraneous compiled files, caches, logs, etc.
 
 endef
 export HELP
 
 
 .PHONY: run install deploy update format lint clean help
 
-requirements: .requirements.txt
-env: ./.venv/bin/activate
-
-
-.requirements.txt: requirements.txt
-	$(shell . .venv/bin/activate && pip install -r requirements.txt)
-
-
 all help:
 	@echo "$$HELP"
 
+env: $(VIRTUAL_ENV)
+
+$(VIRTUAL_ENV):
+	if [ ! -d $(VIRTUAL_ENV) ]; then \
+		echo "Creating Python virtual env in \`${VIRTUAL_ENV}\`"; \
+		python3 -m venv $(VIRTUAL_ENV); \
+	fi
 
 .PHONY: run
 run: env
-	flask run
-
+	$(LOCAL_PYTHON) -m main
 
 .PHONY: install
-install:
-	if [ ! -d "./.venv" ]; then python3 -m venv $(VIRTUAL_ENVIRONMENT); fi
-	. .venv/bin/activate
-	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel
-	$(LOCAL_PYTHON) -m pip install -r requirements.txt
-
+install: env
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	$(LOCAL_PYTHON) -m pip install -r requirements.txt && \
+	npm i -g less && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
 
 .PHONY: deploy
 deploy:
-	make install
+	make install && \
 	make run
 
+.PHONY: test
+test: env
+	$(LOCAL_PYTHON) -m \
+		coverage run -m pytest -vv \
+		--disable-pytest-warnings && \
+		coverage html --title='Coverage Report' -d .reports && \
+		open .reports/index.html
 
 .PHONY: update
-update:
-	if [ ! -d "./.venv" ]; then python3 -m venv $(VIRTUAL_ENVIRONMENT); fi
-	.venv/bin/python3 -m pip install --upgrade pip setuptools wheel
-	poetry update
-	poetry export -f requirements.txt --output requirements.txt --without-hashes
-
+update: env
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	poetry update && \
+	poetry export -f requirements.txt --output requirements.txt --without-hashes && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
 
 .PHONY: format
 format: env
-	isort --multi-line=3 .
-	black .
-
+	$(LOCAL_PYTHON) -m isort --multi-line=3 . && \
+	$(LOCAL_PYTHON) -m black .
 
 .PHONY: lint
-lint:
-	flake8 . --count \
+lint: env
+	$(LOCAL_PYTHON) -m flake8 . --count \
 			--select=E9,F63,F7,F82 \
-			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs \
+			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs,.reports \
 			--show-source \
 			--statistics
 
-
 .PHONY: clean
 clean:
-	find . -name '*.pyc' -delete
-	find . -name '__pycache__' -delete
-	find . -name 'poetry.lock' -delete
-	find . -name '*.log' -delete
-	find . -name '.DS_Store' -delete
-	find . -wholename 'logs/*.json' -delete
-	find . -wholename '.pytest_cache' -delete
-	find . -wholename '**/.pytest_cache' -delete
-	find . -wholename './logs/*.json' -delete
-	find . -wholename './logs' -delete
-	find . -wholename '*.html' -delete
-	find . -wholename '**/.webassets-cache'  -delete
+	find . -name '.coverage' -delete && \
+	find . -name '*.pyc' -delete \
+	find . -name '__pycache__' -delete \
+	find . -name 'poetry.lock' -delete \
+	find . -name '*.log' -delete \
+	find . -name '.DS_Store' -delete \
+	find . -wholename '**/*.pyc' -delete && \
+	find . -wholename '**/*.html' -delete && \
+	find . -type d -wholename '__pycache__' -exec rm -rf {} + && \
+	find . -type d -wholename '.venv' -exec rm -rf {} + && \
+	find . -type d -wholename '.pytest_cache' -exec rm -rf {} + && \
+	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 {} +

README.md

@@ -1,8 +1,8 @@
 # Flask-SQLAlchemy Tutorial
 
-![Python](https://img.shields.io/badge/Python-v^3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![Flask](https://img.shields.io/badge/Flask-v2.1.1-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Flask-SQLAlchemy](https://img.shields.io/badge/Flask--SQLAlchemy-2.5.1-red.svg?longCache=true&style=flat-square&logo=flask&logoColor=white&colorA=4c566a&colorB=5e81ac)
+![Python](https://img.shields.io/badge/Python-v^3.10-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
+![Flask](https://img.shields.io/badge/Flask-v2.3.3-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Flask-SQLAlchemy](https://img.shields.io/badge/Flask--SQLAlchemy-3.1.1-red.svg?longCache=true&style=flat-square&logo=flask&logoColor=white&colorA=4c566a&colorB=5e81ac)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c)
 [![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/flask-sqlalchemy-tutorial.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b&logo=Github)](https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/issues)
 [![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/flask-sqlalchemy-tutorial.svg?style=flat-square&colorB=ebcb8b&colorA=4c566a&logo=Github)](https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/stargazers)
@@ -13,19 +13,18 @@
 Connect your Flask app to a database using Flask-SQLAlchemy.
 
 * **Tutorial**: https://hackersandslackers.com/manage-database-models-with-flask-sqlalchemy/
-
 * **Demo**: https://flasksqlalchemy.hackersandslackers.app
 
-# Getting Started
+## Getting Started
 
 Get set up locally in two steps:
 
 ### 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 in which to run your application; either `development` or `production`.
+* `ENVIRONMENT`: The environment in which to run your application; either `development` or `production`.
+* `FLASK_DEBUG`: Whether to run Flask in "debug mode".
 * `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
 * `SQLALCHEMY_DATABASE_URI`: SQLAlchemy connection URI to a SQL database.
 
@@ -36,10 +35,10 @@ Replace the values in **.env.example** with your values and rename this file to
 Get up and running with `make deploy`:
 
 ```shell
-$ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
-$ cd flask-sqlalchemy-tutorial
-$ make deploy
-``` 
+git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
+cd flask-sqlalchemy-tutorial
+make deploy
+```
 
 -----
 

config.py

@@ -1,18 +1,16 @@
 """Flask configuration variables."""
-from os import environ, path
-
-from dotenv import load_dotenv
-
-basedir = path.abspath(path.dirname(__file__))
-load_dotenv(path.join(basedir, ".env"))
+from os import environ
 
 
 class Config:
     """Set Flask configuration from .env file."""
 
     # General Config
-    SECRET_KEY = environ.get("SECRET_KEY")
-    FLASK_APP = environ.get("FLASK_APP")
+    ENVIRONMENT = environ.get("ENVIRONMENT")
+
+    # Flask Config
+    FLASK_APP = "main.py"
+    FLASK_DEBUG = environ.get("FLASK_DEBUG")
     FLASK_ENV = environ.get("FLASK_ENV")
 
     # Database

deploy.sh

@@ -3,9 +3,10 @@
 
 
 class User(db.Model):
-    """Data model for user accounts."""
+    """User account data model."""
+
+    __tablename__ = "user"
 
-    __tablename__ = "flasksqlalchemy-tutorial-users"
     id = db.Column(db.Integer, primary_key=True)
     username = db.Column(db.String(64), index=True, unique=True, nullable=False)
     email = db.Column(db.String(80), index=True, unique=True, nullable=False)
@@ -14,4 +15,4 @@ class User(db.Model):
     admin = db.Column(db.Boolean, nullable=False)
 
     def __repr__(self):
-        return "<User {}>".format(self.username)
+        return f"<User id={self.id}, username={self.username}, email={self.email}>"

flask_sqlalchemy_tutorial/models.py

@@ -1,5 +1,5 @@
 """Application routes."""
-from datetime import datetime as dt
+from datetime import datetime
 
 from flask import current_app as app
 from flask import make_response, redirect, render_template, request, url_for
@@ -21,7 +21,7 @@ def user_records():
         new_user = User(
             username=username,
             email=email,
-            created=dt.now(),
+            created=datetime.now(),
             bio="In West Philadelphia born and raised, \
             on the playground is where I spent most of my days",
             admin=False,