tidy up

mransbro · mransbro · commit 74e7129d0490 · 2022-05-29T20:46:29.000+01:00
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,11 @@
+FROM python:3.7.11-slim
+
+WORKDIR  /python-api
+
+COPY requirements.txt requirements.txt
+
+RUN pip install -r requirements.txt
+
+COPY . .
+
+CMD [ "python3", "-m" , "flask", "run", "--host=0.0.0.0"]
diff --git a/README.md b/README.md
@@ -7,8 +7,8 @@ A super simple RESTful api created using Flask. The idea is to have a simple api
 Requirements:
 
 ```sh
-virtualenv -p python3 venv
-source venv/bin/activate
+python -m venv ./venv
+source .venv/bin/activate
 ```
 
 Next, run
@@ -27,31 +27,23 @@ python api.py
 
 ## Example
 
-Flask will run on http://127.0.0.1:5000/. Only one endpoint is available at ``days``.
+Flask will run on http://127.0.0.1:5000/.
 
 ```sh
-$ curl 127.0.0.1:5000/days
+$ curl 127.0.0.1:5000/
 [{"id":1,"name":"Monday"},{"id":2,"name":"Tuesday"},{"id":3,"name":"Wednesday"},{"id":4,"name":"Thursday"},{"id":5,"name":"Friday"},{"id":6,"name":"Saturday"},{"id":7,"name":"Sunday"}]
 ```
 
 To return a single day pass in a number with Monday starting at 1.
 
 ```sh
-$ curl 127.0.0.1:5000/days/2
+$ curl 127.0.0.1:5000/2
 {"day":{"id":2,"name":"Tuesday"}}
 ```
 
 Days will also accept a post message.
 
 ```sh
-$ curl -X POST 127.0.0.1:5000/days
+$ curl -X POST 127.0.0.1:5000/
 {"success":true}
 ```
-
-```sh
-$ curl 127.0.0.1:5000/home
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<title>404 Not Found</title>
-<h1>Not Found</h1>
-<p>The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.</p>
-```
diff --git a/app.py b/app.py
@@ -1,31 +1,35 @@
 from flask import Flask, jsonify, abort
 
 days = [
-    {"id": 1, "name": "Monday"}, 
+    {"id": 1, "name": "Monday"},
     {"id": 2, "name": "Tuesday"},
     {"id": 3, "name": "Wednesday"},
     {"id": 4, "name": "Thursday"},
     {"id": 5, "name": "Friday"},
     {"id": 6, "name": "Saturday"},
-    {"id": 7, "name": "Sunday"}
-    ]
+    {"id": 7, "name": "Sunday"},
+]
 
 api = Flask(__name__)
 
-@api.route('/days', methods=['GET'])
+
+@api.route("/", methods=["GET"])
 def get_days():
     return jsonify(days)
 
-@api.route('/days/<int:day_id>', methods=['GET'])
+
+@api.route("/<int:day_id>", methods=["GET"])
 def get_day(day_id):
-    day = [day for day in days if day['id'] == day_id]
+    day = [day for day in days if day["id"] == day_id]
     if len(day) == 0:
         abort(404)
-    return jsonify({'day': day[0]})
+    return jsonify({"day": day[0]})
 
-@api.route('/days', methods=['POST'])
+
+@api.route("/", methods=["POST"])
 def post_days():
     return jsonify({"success": True}), 201
 
-if __name__ == '__main__':
-    api.run()
+
+if __name__ == "__main__":
+    app.run(debug=True)
diff --git a/requirements.txt b/requirements.txt
@@ -1,9 +1 @@
-click==7.1.2
-Flask==1.1.2
-itsdangerous==1.1.0
-Jinja2==2.11.2
-MarkupSafe==1.1.1
-marshmallow==2.18.0
-marshmallow-jsonapi==0.23.2
-six==1.15.0
-Werkzeug==1.0.1
+flask
