Added Makefile and updated README.

Author: toddbirchard

Makefile

@@ -1,42 +1,58 @@
 SRCPATH := $(CURDIR)
-ENTRYPOINT := $(shell find $(SRCPATH) -name '*.ini')
-PROJECTNAME := $(shell basename "$PWD")
+PROJECTNAME := $(shell basename $(CURDIR))
 
 define HELP
-Manage $(PROJECTNAME).
+Manage $(PROJECTNAME). Usage:
 
-Usage:
-
-make run             - Run uWSGI server for $(PROJECTNAME).
-make restart         - Purge cache & reinstall modules.
-make update          - Update npm production dependencies.
-make clean           - Remove cached files.
+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 update 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:
-	nohup uwsgi $(ENTRYPOINT) &
+	$(shell . .venv/bin/activate && python3 wsgi.py)
+
+
+.PHONY: deploy
+deploy:
+	$(shell . ./deploy.sh)
 
-.PHONY: restart
-restart:
-	pkill -9 -f $(shell uwsgi $(ENTRYPOINT))
-	nohup uwsgi $(ENTRYPOINT) &
 
 .PHONY: update
 update:
-	git pull origin master
-	pkill -9 -f $(shell uwsgi $(ENTRYPOINT))
-	poetry shell
-	poetry update
-	nohup uwsgi $(ENTRYPOINT) &
+	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

@@ -1,6 +1,5 @@
 # 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)
 ![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)
@@ -16,57 +15,38 @@
 
 Make Plotly Dash part of your Flask Application by following this example.
 
-* The full tutorial can be found here: https://hackersandslackers.com/plotly-dash-with-flask/
-* A live demo can be found here: https://plotlydashflask.hackersandslackers.app/
-
-## Installation
-
-**Installation via `requirements.txt`**:
-
-```shell
-$ git clone https://github.com/toddbirchard/plotlydash-flask-tutorial.git
-$ cd plotlydash-flask-tutorial
-$ python3 -m venv myenv
-$ source myenv/bin/activate
-$ pip3 install -r requirements.txt
-$ flask run
-```
+* **Tutorial**: https://hackersandslackers.com/plotly-dash-with-flask/
+* **Demo**: https://plotlydashflask.hackersandslackers.app/
 
-**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
+# Getting Started
 
-```shell
-$ git clone https://github.com/toddbirchard/plotlydash-flask-tutorial.git
-$ cd plotlydash-flask-tutorial
-$ pipenv shell
-$ pipenv update
-$ flask run
-```
+Get set up locally in two steps:
 
-**Installation via [Poetry](https://python-poetry.org/)**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/plotlydash-flask-tutorial.git
-$ cd plotlydash-flask-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.
-* `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/plotlydash-flask-tutorial.git
+$ cd plotlydash-flask-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.

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