Update dependencies; formatting; spelling errors.

Author: toddbirchard

.env.example

@@ -1,4 +1,3 @@
-FLASK_APP=wsgi.py
 FLASK_ENV=development
 SECRET_KEY=randomstringofcharacters
 LESS_BIN=/usr/local/bin/lessc

Makefile

@@ -1,58 +1,103 @@
-SRCPATH := $(CURDIR)
-PROJECTNAME := $(shell basename $(CURDIR))
+PROJECT_NAME := $(shell basename $CURDIR)
+VIRTUAL_ENVIRONMENT := $(CURDIR)/.venv
+LOCAL_PYTHON := $(VIRTUAL_ENVIRONMENT)/bin/python3
 
 define HELP
-Manage $(PROJECTNAME). Usage:
+Manage $(PROJECT_NAME). Usage:
+
+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.
 
-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 deploy update format clean 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_ENVIRONMENT)
 
 
-all help:
-	@echo "$$HELP"
+$(VIRTUAL_ENVIRONMENT):
+	if [ -d $(VIRTUAL_ENVIRONMENT) ]; then \
+		@echo "Creating Python virtual environment..." && \
+		python3 -m venv $(VIRTUAL_ENVIRONMENT) && \
+	fi
 
 
 .PHONY: run
 run: env
-	$(shell . .venv/bin/activate && flask run)
+	$(shell python3 -m wsgi.py)
+
+
+.PHONY: install
+install:
+	if [ ! -d "./.venv" ]; then python3 -m venv $(VIRTUAL_ENVIRONMENT); fi
+	$(shell . .venv/bin/activate)
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel
+	$(LOCAL_PYTHON) -m pip install -r requirements.txt
 
 
 .PHONY: deploy
 deploy:
-	$(shell . ./deploy.sh)
+	make clean
+	make install
+	make run
+
+
+.PHONY: test
+test: env
+	$(LOCAL_PYTHON) -m \
+		coverage run -m pytest -v \
+		--disable-pytest-warnings \
+		&& coverage html --title='Coverage Report' -d .reports \
+		&& open .reports/index.html
 
 
 .PHONY: update
-update: env
-	.venv/bin/python3 -m pip install -U pip
+update:
+	if [ ! -d "./.venv" ]; then python3 -m venv $(VIRTUAL_ENVIRONMENT); fi
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel
 	poetry update
 	poetry export -f requirements.txt --output requirements.txt --without-hashes
 
 
 .PHONY: format
 format: env
-	$(shell . .venv/bin/activate && isort ./)
-	$(shell . .venv/bin/activate && black ./)
+	isort --multi-line=3 .
+	black .
+
+
+.PHONY: lint
+lint: env
+	$(LOCAL_PYTHON) -m flake8 . --count \
+			--select=E9,F63,F7,F82 \
+			--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 'Pipefile.lock' -delete
+	find . -name 'Pipefile.lock' -delete
+	find . -name '*.log' -delete
+	find . -name '.coverage' -delete
+	find . -wholename 'logs/*.json' -delete
+	find . -wholename '*/.pytest_cache' -delete
+	find . -wholename '**/.pytest_cache' -delete
+	find . -wholename './logs/*.json' -delete
+	find . -wholename '.webassets-cache/*' -delete
+	find . -wholename './logs' -delete
+	find . -wholename './.reports' -delete

README.md

@@ -1,11 +1,11 @@
 # Plotly Dash Flask Tutorial
 
-![Python](https://img.shields.io/badge/Python-^3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![Flask](https://img.shields.io/badge/Flask-1.1.2-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Python](https://img.shields.io/badge/Python-^3.9-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
+![Flask](https://img.shields.io/badge/Flask^2.0.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)
-![Pandas](https://img.shields.io/badge/Pandas-v^1.0.0-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Dash](https://img.shields.io/badge/Dash-v1.12.0-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Plotly](https://img.shields.io/badge/Plotly-v4.8.1-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Pandas](https://img.shields.io/badge/Pandas-v^1.4.0-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Dash](https://img.shields.io/badge/Dash-v^2.0.0-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Plotly](https://img.shields.io/badge/Plotly-v^5.8.0-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![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/toddbirchard/plotlydash-flask-tutorial.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b)](https://github.com/toddbirchard/plotlydash-flask-tutorial/issues)
 [![GitHub Stars](https://img.shields.io/github/stars/toddbirchard/plotlydash-flask-tutorial.svg?style=flat-square&colorB=ebcb8b&colorA=4c566a)](https://github.com/toddbirchard/plotlydash-flask-tutorial/stargazers)
@@ -26,7 +26,6 @@ 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`.
 * `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
 * `LESS_BIN` *(optional for static assets)*: Path to your local LESS installation via `which lessc`.
@@ -43,7 +42,7 @@ Get up and running with `make deploy`:
 
 ```shell
 $ git clone https://github.com/hackersandslackers/plotlydash-flask-tutorial.git
-$ cd plotlydash-flask-tutorial
+$ cd dashboard-flask-tutorial
 $ make deploy
 ``` 
 

config.py

@@ -11,7 +11,7 @@ class Config:
     """Flask configuration variables."""
 
     # General Config
-    FLASK_APP = environ.get("FLASK_APP")
+    FLASK_APP = "wsgi.py"
     FLASK_ENV = environ.get("FLASK_ENV")
     SECRET_KEY = environ.get("SECRET_KEY")
 

deploy.sh

@@ -1,10 +1,7 @@
 """Initialize Flask app."""
-from ddtrace import patch_all
 from flask import Flask
 from flask_assets import Environment
 
-patch_all()
-
 
 def init_app():
     """Construct core Flask application with embedded Dash app."""
@@ -19,7 +16,7 @@ def init_app():
         from .assets import compile_static_assets
 
         # Import Dash application
-        from .plotlydash.dashboard import init_dashboard
+        from .dashboard import init_dashboard
 
         app = init_dashboard(app)
 

plotlyflask_tutorial/__init__.py plotly_flask_tutorial/__init__.pyplotlyflask_tutorial/__init__.py renamed to plotly_flask_tutorial/__init__.py

@@ -1,10 +1,8 @@
 """Instantiate a Dash app."""
 import dash
-import dash_core_components as dcc
-import dash_html_components as html
-import dash_table
-import numpy as np
-import pandas as pd
+from dash import dash_table
+from dash import dcc
+from dash import html
 
 from .data import create_dataframe
 from .layout import html_layout