Makeffile, 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

@@ -13,50 +13,30 @@
 Source code for the accompanying tutorial found here: https://hackersandslackers.com/flask-wtforms-forms/
 
 
-## Installation
+# Getting Started
 
-**Installation via `requirements.txt`**:
+Get set up locally in two steps:
 
-```shell
-$ git clone https://github.com/hackersandslackers/flask-wtform-tutorial.git
-$ cd flask-wtform-tutorial
-$ python3 -m venv myenv
-$ source myenv/bin/activate
-$ pip3 install -r requirements.txt
-$ flask run
-```
-
-**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/flask-wtform-tutorial.git
-$ cd flask-wtform-tutorial
-$ pipenv shell
-$ pipenv update
-$ flask run
-```
-
-**Installation via [Poetry](https://python-poetry.org/)**:
-
-```shell
-$ git clone https://github.com/hackersandslackers/flask-wtform-tutorial.git
-$ cd flask-wtform-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`).
 * `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
 
-
 *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-wtform-tutorial.git
+$ cd flask-wtform-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.

config.py

@@ -1,20 +1,21 @@
 """App configuration."""
 from os import environ, path
+
 from dotenv import load_dotenv
 
 # Load variables from .env
 basedir = path.abspath(path.dirname(__file__))
-load_dotenv(path.join(basedir, '.env'))
+load_dotenv(path.join(basedir, ".env"))
 
 
 class Config:
     """Set Flask configuration vars 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")
 
     # Static Assets
-    STATIC_FOLDER = 'static'
-    TEMPLATES_FOLDER = 'templates'
+    STATIC_FOLDER = "static"
+    TEMPLATES_FOLDER = "templates"

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

@@ -5,9 +5,9 @@
 def create_app():
     """Construct the core flask_wtforms_tutorial."""
     app = Flask(__name__, instance_relative_config=False)
-    app.config.from_object('config.Config')
-    app.config['RECAPTCHA_PUBLIC_KEY'] = 'iubhiukfgjbkhfvgkdfm'
-    app.config['RECAPTCHA_PARAMETERS'] = {'size': '100%'}
+    app.config.from_object("config.Config")
+    app.config["RECAPTCHA_PUBLIC_KEY"] = "iubhiukfgjbkhfvgkdfm"
+    app.config["RECAPTCHA_PARAMETERS"] = {"size": "100%"}
 
     with app.app_context():
         # Import parts of our flask_wtforms_tutorial

flask_wtforms_tutorial/forms.py

@@ -1,52 +1,57 @@
 """Form class declaration."""
 from flask_wtf import FlaskForm, RecaptchaField
-from wtforms import (StringField,
-                     TextAreaField,
-                     SubmitField,
-                     PasswordField,
-                     DateField,
-                     SelectField)
-from wtforms.validators import (DataRequired,
-                                Email,
-                                EqualTo,
-                                Length,
-                                URL)
+from wtforms import (
+    DateField,
+    PasswordField,
+    SelectField,
+    StringField,
+    SubmitField,
+    TextAreaField,
+)
+from wtforms.validators import URL, DataRequired, Email, EqualTo, Length
 
 
 class ContactForm(FlaskForm):
     """Contact form."""
 
-    name = StringField('Name', [
-        DataRequired()])
-    email = StringField('Email', [
-        Email(message='Not a valid email address.'),
-        DataRequired()])
-    body = TextAreaField('Message', [
-        DataRequired(),
-        Length(min=4, message='Your message is too short.')])
-    submit = SubmitField('Submit')
+    name = StringField("Name", [DataRequired()])
+    email = StringField(
+        "Email", [Email(message="Not a valid email address."), DataRequired()]
+    )
+    body = TextAreaField(
+        "Message", [DataRequired(), Length(min=4, message="Your message is too short.")]
+    )
+    submit = SubmitField("Submit")
 
 
 class SignupForm(FlaskForm):
     """Sign up for a user account."""
 
-    email = StringField('Email', [
-        Email(message='Not a valid email address.'),
-        DataRequired()])
-    password = PasswordField('Password', [
-        DataRequired(message="Please enter a password."),
-    ])
-    confirmPassword = PasswordField('Repeat Password', [
-            EqualTo(password, message='Passwords must match.')
-            ])
-    title = SelectField('Title', [DataRequired()],
-                        choices=[('Farmer', 'farmer'),
-                                 ('Corrupt Politician', 'politician'),
-                                 ('No-nonsense City Cop', 'cop'),
-                                 ('Professional Rocket League Player', 'rocket'),
-                                 ('Lonely Guy At A Diner', 'lonely'),
-                                 ('Pokemon Trainer', 'pokemon')])
-    website = StringField('Website', validators=[URL()])
-    birthday = DateField('Your Birthday')
+    email = StringField(
+        "Email", [Email(message="Not a valid email address."), DataRequired()]
+    )
+    password = PasswordField(
+        "Password",
+        [
+            DataRequired(message="Please enter a password."),
+        ],
+    )
+    confirmPassword = PasswordField(
+        "Repeat Password", [EqualTo(password, message="Passwords must match.")]
+    )
+    title = SelectField(
+        "Title",
+        [DataRequired()],
+        choices=[
+            ("Farmer", "farmer"),
+            ("Corrupt Politician", "politician"),
+            ("No-nonsense City Cop", "cop"),
+            ("Professional Rocket League Player", "rocket"),
+            ("Lonely Guy At A Diner", "lonely"),
+            ("Pokemon Trainer", "pokemon"),
+        ],
+    )
+    website = StringField("Website", validators=[URL()])
+    birthday = DateField("Your Birthday")
     recaptcha = RecaptchaField()
-    submit = SubmitField('Submit')
+    submit = SubmitField("Submit")

flask_wtforms_tutorial/routes.py

@@ -1,35 +1,30 @@
-from flask import url_for, render_template, redirect
 from flask import current_app as app
+from flask import redirect, render_template, url_for
+
 from .forms import ContactForm, SignupForm
 
 
-@app.route('/')
+@app.route("/")
 def home():
-    return render_template('index.jinja2',
-                           template='home-template')
+    return render_template("index.jinja2", template="home-template")
 
 
-@app.route('/contact', methods=('GET', 'POST'))
+@app.route("/contact", methods=("GET", "POST"))
 def contact():
     form = ContactForm()
     if form.validate_on_submit():
-        return redirect(url_for('success'))
-    return render_template('contact.jinja2',
-                           form=form,
-                           template='form-template')
+        return redirect(url_for("success"))
+    return render_template("contact.jinja2", form=form, template="form-template")
 
 
-@app.route('/signup', methods=('GET', 'POST'))
+@app.route("/signup", methods=("GET", "POST"))
 def signup():
     form = SignupForm()
     if form.validate_on_submit():
-        return redirect(url_for('success'))
-    return render_template('signup.jinja2',
-                           form=form,
-                           template='form-template')
+        return redirect(url_for("success"))
+    return render_template("signup.jinja2", form=form, template="form-template")
 
 
-@app.route('/success', methods=('GET', 'POST'))
+@app.route("/success", methods=("GET", "POST"))
 def success():
-    return render_template('success.jinja2',
-                           template='success-template')
+    return render_template("success.jinja2", template="success-template")