add files

Author: mohsenasm

.gitignore

@@ -0,0 +1,10 @@
+.idea/
+.vscode/
+
+__pycache__/
+*.py[cod]
+*$py.class
+venv/
+env/
+
+.DS_Store

app/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.9-buster
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+CMD [ "python", "app.py" ]

app/app.py

@@ -0,0 +1,39 @@
+from flask import Flask
+from flask_restful import Api
+from flask_apispec import FlaskApiSpec
+
+from resources import HelloWorld, Car
+from models import db
+
+
+def create_app():
+    app = Flask(__name__)
+
+    # Config
+    app.config['SQLALCHEMY_ECHO'] = False
+    app.config['SECRET_KEY'] = 'super_secret_key'
+    app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://postgres:the_pass@db:5432/the_db'
+    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+
+    # DB
+    db.app = app
+    db.init_app(app)
+    # just for demo :)
+    db.drop_all()
+    db.create_all()
+
+    # API
+    api = Api(app)
+    api.add_resource(HelloWorld, '/')
+    api.add_resource(Car, '/car')
+
+    # Spec (/swagger & /swagger-ui)
+    docs = FlaskApiSpec(app)
+    docs.register(Car)
+
+    return app
+
+
+if __name__ == '__main__':
+    app = create_app()
+    app.run(port=7654, host='0.0.0.0')

app/models.py

@@ -0,0 +1,18 @@
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+
+
+class CarsModel(db.Model):
+    __tablename__ = 'cars'
+
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String())
+    doors = db.Column(db.Integer())
+
+    def __init__(self, name, doors):
+        self.name = name
+        self.doors = doors
+
+    def __repr__(self):
+        return f"<Car {self.name}>"

app/requirements.txt

@@ -0,0 +1,5 @@
+Flask==1.1.2
+flask-apispec==0.11.0
+Flask-RESTful==0.3.8
+Flask-SQLAlchemy==2.5.1
+psycopg2-binary==2.8.6

app/resources.py

@@ -0,0 +1,41 @@
+from flask_restful import Resource
+from flask_apispec import MethodResource, marshal_with, use_kwargs
+import marshmallow as ma
+
+from models import db, CarsModel
+
+
+class HelloWorld(Resource):
+    def get(self):
+        return {'hello': 'world'}
+
+
+class CarSchema(ma.Schema):
+    name = ma.fields.Str()
+    doors = ma.fields.Int()
+
+
+class MessageSchema(ma.Schema):
+    message = ma.fields.Str()
+
+
+class Car(MethodResource, Resource):
+    @marshal_with(CarSchema(many=True), code=200)
+    def get(self):
+        cars = CarsModel.query.all()
+        return [
+            {
+                "name": car.name,
+                "doors": car.doors
+            } for car in cars]
+
+    @use_kwargs(CarSchema)
+    @marshal_with(MessageSchema, code=200)
+    def post(self, **kwargs):
+        if any(param not in kwargs for param in ["name", "doors"]):
+            return {"message": "missed an argument"}, 400
+        new_car = CarsModel(name=kwargs["name"], doors=kwargs["doors"])
+        db.session.add(new_car)
+        db.session.commit()
+        return {"message": f"car {new_car.name} has been created successfully."}
+

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3'
+
+services:
+    app:
+        build: './app'
+        restart: always
+        ports:
+            - 7654:7654
+        # we should use something like `wait-for-it.sh` in real life
+
+    db:
+        image: 'postgres:13-alpine'
+        environment:
+            POSTGRES_DB: 'the_db'
+            POSTGRES_USER: 'postgres'
+            POSTGRES_PASSWORD: 'the_pass'
+        expose:
+            - 5432
+        volumes:
+            - db_data:/var/lib/postgresql/data
+
+volumes:
+    db_data:

readme.md

@@ -0,0 +1,5 @@
+# Run
+    docker-compose up --build
+
+# Documentation & Demo
+    http://localhost:7654/swagger-ui