bump dependencies, lint, update readme

Author: mjhea0

README.md

@@ -10,4 +10,8 @@ Spin up the containers:
 $ docker-compose up -d --build
 ```
 
-Open your browser to http://localhost:5004
+Open your browser to http://localhost:5004 to view the app or to http://localhost:9181 to view the RQ dashboard.
+
+### Want to learn how to build this?
+
+Check out the [post](https://testdriven.io/asynchronous-tasks-with-flask-and-redis-queue).

docker-compose.yml

@@ -14,3 +14,28 @@ services:
     environment:
       - FLASK_DEBUG=1
       - APP_SETTINGS=project.server.config.DevelopmentConfig
+    depends_on:
+      - redis
+
+  worker:
+    image: web
+    command: python manage.py run_worker
+    volumes:
+      - .:/usr/src/app
+    environment:
+      - APP_SETTINGS=project.server.config.DevelopmentConfig
+    depends_on:
+      - redis
+
+  redis:
+    image: redis:5.0.7-alpine
+
+  dashboard:
+    build: ./project/dashboard
+    image: dashboard
+    container_name: dashboard
+    ports:
+      - 9181:9181
+    command: rq-dashboard -H redis
+    depends_on:
+      - redis

manage.py

@@ -3,6 +3,8 @@
 
 import unittest
 
+import redis
+from rq import Connection, Worker
 from flask.cli import FlaskGroup
 
 from project.server import create_app
@@ -22,5 +24,14 @@ def test():
     return 1
 
 
+@cli.command("run_worker")
+def run_worker():
+    redis_url = app.config["REDIS_URL"]
+    redis_connection = redis.from_url(redis_url)
+    with Connection(redis_connection):
+        worker = Worker(app.config["QUEUES"])
+        worker.work()
+
+
 if __name__ == "__main__":
     cli()

project/dashboard/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.8.0-alpine
+
+RUN pip install rq-dashboard
+
+EXPOSE 9181
+
+CMD ["rq-dashboard"]

project/server/config.py

@@ -9,6 +9,8 @@ class BaseConfig(object):
     """Base configuration."""
 
     WTF_CSRF_ENABLED = True
+    REDIS_URL = "redis://redis:6379/0"
+    QUEUES = ["default"]
 
 
 class DevelopmentConfig(BaseConfig):

project/server/main/tasks.py

@@ -0,0 +1,9 @@
+# project/server/main/tasks.py
+
+
+import time
+
+
+def create_task(task_type):
+    time.sleep(int(task_type) * 10)
+    return True

project/server/main/views.py

@@ -1,7 +1,11 @@
 # project/server/main/views.py
 
 
-from flask import render_template, Blueprint, jsonify, request
+import redis
+from rq import Queue, Connection
+from flask import render_template, Blueprint, jsonify, request, current_app
+
+from project.server.main.tasks import create_task
 
 main_blueprint = Blueprint("main", __name__,)
 
@@ -14,9 +18,32 @@ def home():
 @main_blueprint.route("/tasks", methods=["POST"])
 def run_task():
     task_type = request.form["type"]
-    return jsonify(task_type), 202
+    with Connection(redis.from_url(current_app.config["REDIS_URL"])):
+        q = Queue()
+        task = q.enqueue(create_task, task_type)
+    response_object = {
+        "status": "success",
+        "data": {
+            "task_id": task.get_id()
+        }
+    }
+    return jsonify(response_object), 202
 
 
 @main_blueprint.route("/tasks/<task_id>", methods=["GET"])
 def get_status(task_id):
-    return jsonify(task_id)
+    with Connection(redis.from_url(current_app.config["REDIS_URL"])):
+        q = Queue()
+        task = q.fetch_job(task_id)
+    if task:
+        response_object = {
+            "status": "success",
+            "data": {
+                "task_id": task.get_id(),
+                "task_status": task.get_status(),
+                "task_result": task.result,
+            },
+        }
+    else:
+        response_object = {"status": "error"}
+    return jsonify(response_object)

requirements.txt

@@ -2,3 +2,5 @@ Flask==1.1.1
 Flask-Bootstrap==3.3.7.1
 Flask-Testing==0.7.1
 Flask-WTF==0.14.2
+redis==3.3.11
+rq==1.1.0