[flask-sqlalchemy] getting started w/ flask + sqlalchemy app example

siegerts · siegerts · commit 3c8be2ca1f6c · 2020-04-09T12:30:37.000-04:00
diff --git a/flask-getting-started-sqlalchemy/README.md b/flask-getting-started-sqlalchemy/README.md
@@ -0,0 +1,25 @@
+## Using Flask-SQLAlchemy with Flask Applications on RStudio Connect
+
+This application structure and set-up follows the steps outlined in
+[Using Flask-SQLAlchemy with Flask Applications on RStudio Connect](https://support.rstudio.com/hc/en-us/articles/360045926213):
+
+- Creating a minimal application based on the Flask-SQLAlchemy quickstart guide
+- Define the database model to use
+- Initialize a SQLite database
+- Commit data to the database
+- Deploy the application to RStudio Connect with rsconnect-python
+
+And, optionally:
+
+- Switch to a PostgreSQL database server
+- Add `pyscopg2` dependency to the Python environment
+- Add the database server connection string as an environment variable in RStudio Connect
+- Redeploy the application
+
+---
+
+### Additional Resources
+
+- [Getting Started with Flask and RStudio Connect](https://support.rstudio.com/hc/en-us/articles/360044700234)
+- [Deploying Flask Applications to RStudio Connect with Git and rsconnect-python](https://support.rstudio.com/hc/en-us/articles/360045224233)
+- [Using Templates and Static Assets with Flask Applications on RStudio Connect](https://support.rstudio.com/hc/en-us/articles/360045279313)
diff --git a/flask-getting-started-sqlalchemy/app.py b/flask-getting-started-sqlalchemy/app.py
@@ -0,0 +1,28 @@
+from flask import Flask, render_template
+from flask_sqlalchemy import SQLAlchemy
+import os
+
+
+app = Flask(__name__)
+basedir = os.path.abspath(os.path.dirname(__file__))
+
+SQLALCHEMY_DATABASE_URI = os.environ.get("DATABASE_URI") or "sqlite:///" + os.path.join(
+    basedir, "users.db"
+)
+
+app.config["SQLALCHEMY_DATABASE_URI"] = SQLALCHEMY_DATABASE_URI
+
+# initialize the extension
+db = SQLAlchemy(app)
+
+
+class User(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String, unique=True, nullable=False)
+    email = db.Column(db.String, unique=True, nullable=False)
+
+
+@app.route("/")
+def index():
+    users = User.query.all()
+    return render_template("index.html", users=users)
diff --git a/flask-getting-started-sqlalchemy/manifest.json b/flask-getting-started-sqlalchemy/manifest.json
@@ -0,0 +1,33 @@
+{
+  "version": 1,
+  "metadata": {
+    "appmode": "python-api",
+    "entrypoint": "app:app"
+  },
+  "locale": "en_US.UTF-8",
+  "python": {
+    "version": "3.7.4",
+    "package_manager": {
+      "name": "pip",
+      "version": "19.0.3",
+      "package_file": "requirements.txt"
+    }
+  },
+  "files": {
+    "requirements.txt": {
+      "checksum": "f00237682b99f60fa6d297c278e87fe5"
+    },
+    "app.py": {
+      "checksum": "e4ccd14db159c5bcc7ea67cbfaff2cfb"
+    },
+    "static/style.css": {
+      "checksum": "f49bd4d078ffd375f2deb76e0cdb5cf3"
+    },
+    "templates/index.html": {
+      "checksum": "f3d3be99cf0a8467bdb2548b90f9076f"
+    },
+    "users.db": {
+      "checksum": "7f391d911e8d45d2326a02f98fa45048"
+    }
+  }
+}
diff --git a/flask-getting-started-sqlalchemy/requirements.txt b/flask-getting-started-sqlalchemy/requirements.txt
@@ -0,0 +1,11 @@
+click==7.1.1
+Flask==1.1.1
+Flask-SQLAlchemy==2.4.1
+itsdangerous==1.1.0
+Jinja2==2.11.1
+MarkupSafe==1.1.1
+psycopg2==2.8.4
+rsconnect-python==1.4.2.1
+six==1.14.0
+SQLAlchemy==1.3.15
+Werkzeug==1.0.0
diff --git a/flask-getting-started-sqlalchemy/static/style.css b/flask-getting-started-sqlalchemy/static/style.css
@@ -0,0 +1,8 @@
+.ba {
+  border-style: solid;
+  border-width: 1px;
+}
+
+.pa {
+  padding: 1rem;
+}
