Update dependencies & Make commands for Apple silicon.

Author: toddbirchard

.env.example

@@ -1,9 +1,9 @@
+ENVIRONMENT=development
 FLASK_APP=wsgi.py
-FLASK_ENV=production
+FLASK_DEBUG=True
 SECRET_KEY=yoursecretkey
 SQLALCHEMY_DATABASE_URI=mysql+pymysql://myuser:mypassword@host.example.com:1234/mydatabase
 REDIS_URI=redis://:password@host.com:1234
 COMPRESSOR_DEBUG=True
-LESS_BIN=/usr/local/bin/lessc
 ASSETS_DEBUG=False
 LESS_RUN_IN_DEBUG=False

.gitignore

@@ -99,11 +99,12 @@ venv.bak/
 # mkdocs documentation
 /site
 
-# mypy
+# MyPy
 .mypy_cache/
 
+# IDEs
+.idea
+.vscode
+
 # Etc
 .DS_Store
-creds
-.idea
-.idea/*

Makefile

@@ -1,47 +1,52 @@
 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
 
+all help:
+	@echo "$$HELP"
 
-.requirements.txt: requirements.txt
-	$(shell . .venv/bin/activate && pip install -r requirements.txt)
 
+env: $(VIRTUAL_ENV)
 
-all help:
-	@echo "$$HELP"
+
+$(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
+	export LESS_BIN=$(shell which lessc)
+	uwsgi --http 127.0.0.1:8082 --master --module wsgi:app --processes 4 --threads 2
 
 
 .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 --no-cache-dir uwsgi && \
+	$(LOCAL_PYTHON) -m pip install -r requirements.txt && \
+	npm i -g less && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
 
 
 .PHONY: deploy
@@ -50,40 +55,55 @@ deploy:
 	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 && \
+	$(LOCAL_PYTHON) -m pip install --no-cache-dir uwsgi && \
+	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 'poetry.lock' -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 './logs/*' -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-Session 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-v^2.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.6.0-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![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)
@@ -18,7 +18,7 @@
 
 **Tutorial**: https://hackersandslackers.com/managing-user-session-variables-with-flask-sessions-and-redis/
 
-# Getting Started
+## Getting Started
 
 Get set up locally in two steps:
 
@@ -27,7 +27,7 @@ Get set up locally in two steps:
 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`.
+* `FLASK_DEBUG`: Toggle debug mode on (`True`) or off (`False`).
 * `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.
@@ -36,18 +36,17 @@ Replace the values in **.env.example** with your values and rename this file to
 * `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
-``` 
+git clone https://github.com/hackersandslackers/flask-session-tutorial.git
+cd flask-session-tutorial
+make deploy
+```
 
 -----
 

config.py

@@ -1,5 +1,5 @@
 """App configuration."""
-from os import environ, path
+from os import environ, path, system
 
 import redis
 from dotenv import load_dotenv
@@ -12,8 +12,9 @@ class Config:
     """Set Flask configuration variables from .env file."""
 
     # General Config
+    ENVIRONMENT = environ.get("ENVIRONMENT")
     FLASK_APP = environ.get("FLASK_APP")
-    FLASK_ENV = environ.get("FLASK_ENV")
+    FLASK_DEBUG = environ.get("FLASK_DEBUG")
     SECRET_KEY = environ.get("SECRET_KEY")
 
     # Flask-Session
@@ -22,7 +23,7 @@ class Config:
     SESSION_REDIS = redis.from_url(REDIS_URI)
 
     # Flask-Assets
-    LESS_BIN = environ.get("LESS_BIN")
+    LESS_BIN = system("which lessc")
     ASSETS_DEBUG = False
     LESS_RUN_IN_DEBUG = False
 

deploy.sh

@@ -20,7 +20,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"] != "production":
+    if app.config.get("ENVIRONMENT") != "production":
         less_bundle.build(force=True)
         js_bundle.build()
 
@@ -40,7 +40,7 @@ def compile_main_assets(app):
     # Register assets
     assets.register("less_all", less_bundle)
     # Build assets in development mode
-    if app.config["FLASK_ENV"] != "production":
+    if app.config.get("ENVIRONMENT") != "production":
         less_bundle.build(force=True)