Updated README, added pyproject.toml.

Author: toddbirchard

Pipfile.lock

@@ -1,7 +1,7 @@
 # Flask-SQLAlchemy Tutorial
 
 ![Python](https://img.shields.io/badge/Python-v^3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![Flask](https://img.shields.io/badge/Flask-v1.1.1-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Flask](https://img.shields.io/badge/Flask-v1.1.2-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![Flask-SQLAlchemy](https://img.shields.io/badge/Flask--SQLAlchemy-2.4.1-red.svg?longCache=true&style=flat-square&logo=flask&logoColor=white&colorA=4c566a&colorB=5e81ac)
 ![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/hackersandslackers/flask-sqlalchemy-tutorial.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b&logo=Github)](https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/issues)
@@ -12,26 +12,38 @@
 
 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/).
 
-## Getting Started
+## Installation
 
-Installation is recommended with Pipenv:
+**Installation via `requirements.txt`**:
 
 ```shell
 $ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
 $ cd flask-sqlalchemy-tutorial
-$ pipenv shell
-$ pipenv update
+$ python3 -m venv myenv
+$ source myenv/bin/activate
+$ pip3 install -r requirements.txt
 $ flask run
 ```
 
-Alternatively, try installing via `requirements.txt`:
+**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
 
 ```shell
 $ git clone https://github.com/hackersandslackers/flask-sqlalchemy-tutorial.git
-$ cd flasksession-tutorial
-$ python3 -m pip install requirements.txt
+$ cd flask-sqlalchemy-tutorial
+$ pipenv shell
+$ pipenv update
 $ flask run
 ```
+
+## Configuration
+
+Configuration is handled by creating a **.env** file. This should contain the following variables (replace the values with your own):
+
+```.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

@@ -6,7 +6,7 @@
 
 @app.route('/', methods=['GET'])
 def create_user():
-    """Create a user."""
+    """Create a user via query string parameters."""
     username = request.args.get('user')
     email = request.args.get('email')
     if username and email:
@@ -20,6 +20,6 @@ def create_user():
                         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
-    return render_template('users.html',
+    return render_template('users.jinja2',
                            users=User.query.all(),
                            title="Show Users")

application/routes.py

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "layout.jinja2" %}
 
 {% block content %}
     <div class="container">

application/templates/layout.html renamed to application/templates/layout.jinja2

@@ -0,0 +1,36 @@
+[tool.poetry]
+name = "Flask SQLAlchemy Tutorial"
+version = "0.1.0"
+description = "Connect your Flask app to a database using Flask-SQLAlchemy."
+authors = ["Todd Birchard <toddbirchard@gmail.com>"]
+maintainers = ["Todd Birchard <toddbirchard@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://hackersandslackers.com/flask-sqlalchemy-database-models/"
+repository = "https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/"
+documentation = "https://hackersandslackers.com/flask-sqlalchemy-database-models/"
+keywords = ["Flask",
+            "SQLAlchemy",
+            "SQL",
+            "Frameworks",
+            "Tutorial"]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+flask = "*"
+flask-sqlalchemy = "*"
+pymysql = "*"
+python-dotenv = "*"
+
+[tool.poetry.dev-dependencies]
+pytest = "*"
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"
+
+[tool.poetry.scripts]
+run = "wsgi:__main__"
+
+[tool.poetry.urls]
+issues = "https://github.com/hackersandslackers/flask-sqlalchemy-tutorial/issues"

application/templates/users.html renamed to application/templates/users.jinja2

@@ -1,4 +1,4 @@
-click==7.1.1
+click==7.1.2
 Flask==1.1.2
 Flask-SQLAlchemy==2.4.1
 itsdangerous==1.1.0