Refactor.

Author: toddbirchard

.env.example

@@ -0,0 +1,3 @@
+FLASK_ENV=production
+SECRET_KEY=YOURSECRETKEY
+SQLALCHEMY_DATABASE_URI=mysql+pymysql://[USER]:[PASSWORD]@[HOST]:[PORT]/[DATABASE_NAME]

Pipfile

@@ -9,7 +9,7 @@ verify_ssl = true
 Flask = "*"
 Flask-SQLAlchemy = "*"
 PyMySQL = "*"
-python-dotenv = "*"
+Python-dotenv = "*"
 
 [requires]
 python_version = "3.8"

Pipfile.lock

@@ -35,15 +35,17 @@ $ pipenv update
 $ flask run
 ```
 
-## Configuration
+## Usage
 
-Configuration is handled by creating a **.env** file. This should contain the following variables (replace the values with your own):
+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.*
 
-```.env
-FLASK_ENV="production"
-SECRET_KEY="YOURSECRETKEY"
-SQLALCHEMY_DATABASE_URI="mysql+pymysql://[USER]:[PASSWORD]@[HOST]:[PORT]/[DATABASE_NAME]"
-```
 -----
 
 **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.

README.md

@@ -1,3 +1,4 @@
+"""Flask configuration variables."""
 from os import environ, path
 from dotenv import load_dotenv
 
@@ -6,13 +7,12 @@
 
 
 class Config:
-    """Set Flask configuration variables from .env file."""
+    """Set Flask configuration from .env file."""
 
-    # General Flask Config
+    # General Config
     SECRET_KEY = environ.get('SECRET_KEY')
+    FLASK_APP = environ.get('FLASK_APP')
     FLASK_ENV = environ.get('FLASK_ENV')
-    FLASK_APP = 'wsgi.py'
-    FLASK_DEBUG = 1
 
     # Database
     SQLALCHEMY_DATABASE_URI = environ.get("SQLALCHEMY_DATABASE_URI")

application/models.py

@@ -1,3 +1,4 @@
+"""Initialize Flask app."""
 from flask import Flask
 from flask_sqlalchemy import SQLAlchemy
 

application/routes.py

@@ -0,0 +1,45 @@
+"""Data models."""
+from . import db
+
+
+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
+    )
+
+    def __repr__(self):
+        return '<User {}>'.format(self.username)