Easy install Makefile, formatting.

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 deploy update format 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"
+
+
+.PHONY: run
+run: env
+	$(shell . .venv/bin/activate && flask run)
+
+
+.PHONY: deploy
+deploy:
+	$(shell . ./deploy.sh)
+
+
+.PHONY: update
+update: env
+	.venv/bin/python3 -m pip install -U pip
+	poetry update
+	poetry export -f requirements.txt --output requirements.txt --without-hashes
+
+
+.PHONY: format
+format: env
+	$(shell . .venv/bin/activate && isort -rc ./)
+	$(shell . .venv/bin/activate && black ./)
+
+
+.PHONY: clean
+clean:
+	find . -name '*.pyc' -delete
+	find . -name '__pycache__' -delete
+	find . -name 'poetry.lock' -delete
+	find . -name 'Pipefile.lock' -delete

README.md

@@ -10,54 +10,36 @@
 
 ![Flask-SQLAlchemy Tutorial](https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/blob/master/.github/flask-sqlachemy@2x.jpg?raw=true)
 
-Connect your Flask app to a database using Flask-SQLAlchemy. This repository contains source code for the accompanying tutorial on [Hackers and Slackers](https://hackersandslackers.com/manage-database-models-with-flask-sqlalchemy/).
+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
 
-Working demo here: https://flasksqlalchemy.hackersandslackers.app
+# Getting Started
 
-## Installation
+Get set up locally in two steps:
 
-**Installation via `requirements.txt`**:
+### Environment Variables
 
-```shell
-$ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
-$ cd flask-sqlalchemy-tutorial
-$ python3 -m venv myenv
-$ source myenv/bin/activate
-$ pip3 install -r requirements.txt
-$ flask run
-```
+Replace the values in **.env.example** with your values and rename this file to **.env**:
 
-**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
+* `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.
+* `SQLALCHEMY_DATABASE_URI`: SQLAlchemy connection URI to a SQL database.
 
-```shell
-$ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
-$ cd flask-sqlalchemy-tutorial
-$ pipenv shell
-$ pipenv update
-$ flask run
-```
+*Remember never to commit secrets saved in .env files to Github.*
 
-**Installation via [Poetry](https://python-poetry.org/)**:
+### Installation
+
+Get up and running with `make deploy`:
 
 ```shell
 $ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
 $ cd flask-sqlalchemy-tutorial
-$ poetry shell
-$ poetry update
-$ poetry run
-```
-
-## Usage
-
-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`).
-* `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
-* `SQLALCHEMY_DATABASE_URI`: SQLAlchemy connection URI to a SQL database.
-
-*Remember never to commit secrets saved in .env files to Github.*
+$ 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.
+**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.

config.py

@@ -1,18 +1,19 @@
 """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'))
+load_dotenv(path.join(basedir, ".env"))
 
 
 class Config:
     """Set Flask configuration from .env file."""
 
     # General Config
-    SECRET_KEY = environ.get('SECRET_KEY')
-    FLASK_APP = environ.get('FLASK_APP')
-    FLASK_ENV = environ.get('FLASK_ENV')
+    SECRET_KEY = environ.get("SECRET_KEY")
+    FLASK_APP = environ.get("FLASK_APP")
+    FLASK_ENV = environ.get("FLASK_ENV")
 
     # Database
     SQLALCHEMY_DATABASE_URI = environ.get("SQLALCHEMY_DATABASE_URI")

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_sqlalchemy_tutorial/__init__.py

@@ -8,12 +8,13 @@
 def create_app():
     """Construct the core application."""
     app = Flask(__name__, instance_relative_config=False)
-    app.config.from_object('config.Config')
+    app.config.from_object("config.Config")
 
     db.init_app(app)
 
     with app.app_context():
         from . import routes  # Import routes
+
         db.create_all()  # Create database tables for our data models
 
         return app

flask_sqlalchemy_tutorial/models.py

@@ -5,41 +5,13 @@
 class User(db.Model):
     """Data model for user accounts."""
 
-    __tablename__ = 'flasksqlalchemy-tutorial-users'
-    id = db.Column(
-        db.Integer,
-        primary_key=True
-    )
-    username = db.Column(
-        db.String(64),
-        index=False,
-        unique=True,
-        nullable=False
-    )
-    email = db.Column(
-        db.String(80),
-        index=True,
-        unique=True,
-        nullable=False
-    )
-    created = db.Column(
-        db.DateTime,
-        index=False,
-        unique=False,
-        nullable=False
-    )
-    bio = db.Column(
-        db.Text,
-        index=False,
-        unique=False,
-        nullable=True
-    )
-    admin = db.Column(
-        db.Boolean,
-        index=False,
-        unique=False,
-        nullable=False
-    )
+    __tablename__ = "flasksqlalchemy-tutorial-users"
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String(64), index=False, unique=True, nullable=False)
+    email = db.Column(db.String(80), index=True, unique=True, nullable=False)
+    created = db.Column(db.DateTime, index=False, unique=False, nullable=False)
+    bio = db.Column(db.Text, index=False, unique=False, nullable=True)
+    admin = db.Column(db.Boolean, index=False, unique=False, nullable=False)
 
     def __repr__(self):
-        return '<User {}>'.format(self.username)
+        return "<User {}>".format(self.username)

flask_sqlalchemy_tutorial/routes.py

@@ -1,34 +1,32 @@
 """Application routes."""
 from datetime import datetime as dt
-from flask import request, render_template, make_response, redirect, url_for
+
 from flask import current_app as app
-from .models import db, User
+from flask import make_response, redirect, render_template, request, url_for
+
+from .models import User, db
 
 
-@app.route('/', methods=['GET'])
+@app.route("/", methods=["GET"])
 def user_records():
     """Create a user via query string parameters."""
-    username = request.args.get('user')
-    email = request.args.get('email')
+    username = request.args.get("user")
+    email = request.args.get("email")
     if username and email:
         existing_user = User.query.filter(
             User.username == username or User.email == email
         ).first()
         if existing_user:
-            return make_response(f'{username} ({email}) already created!')
+            return make_response(f"{username} ({email}) already created!")
         new_user = User(
             username=username,
             email=email,
             created=dt.now(),
             bio="In West Philadelphia born and raised, \
             on the playground is where I spent most of my days",
-            admin=False
+            admin=False,
         )  # Create an instance of the User class
         db.session.add(new_user)  # Adds new User record to database
         db.session.commit()  # Commits all changes
-        redirect(url_for('user_records'))
-    return render_template(
-        'users.jinja2',
-        users=User.query.all(),
-        title="Show Users"
-    )
+        redirect(url_for("user_records"))
+    return render_template("users.jinja2", users=User.query.all(), title="Show Users")