Initial commit

Author: ThomasKranitsas

README.md

@@ -0,0 +1,59 @@
+# Python Postgres Starter Pack
+
+## Prerequisites
+1. Python 3.x
+2. Postgres database
+3. docker & docker-compose
+
+## Configuration
+
+Located under the yaml file.
+
+- **SQLALCHEMY_DATABASE_URI** postgres db connection url
+
+the config value can be set through environment variable **SQLALCHEMY_DATABASE_URI**.
+
+## Local Running
+
+Go to app folder.
+
+Install requirements:
+
+```bash
+pip install -r requirements.txt
+```
+
+you can run flask migration to create table
+
+```bash
+flask db init
+flask db migrate
+flask db upgrade
+```
+or run the db/init-scripts/ddl.sql to create table
+
+
+Run application
+
+```bash
+python app.py
+```
+
+or override with environment variable
+
+```bash
+SQLALCHEMY_DATABASE_URI=xxx python app.py
+```
+
+
+## Docker compose Running
+
+Run:
+```bash
+docker-compose up --build
+```
+
+
+## Test and Verification
+
+Import the postman collection in docs folder to test and verify.

app/Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3
+
+# Copy app
+COPY . /app
+
+WORKDIR /app
+
+# Install dependenceis
+RUN pip install -r requirements.txt
+
+# Expose port 5000
+EXPOSE 5000
+
+# Run the server when container is launched
+CMD ["python", "app.py"]

app/app.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+from config import app
+from controllers.user_controller import api
+
+# register the api
+app.register_blueprint(api)
+
+if __name__ == '__main__':
+    ''' run application '''
+    app.run(host='0.0.0.0', port=5000)

app/config.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+import os
+import yaml
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+
+
+app = Flask(__name__)
+
+config_obj = yaml.load(open('config.yaml'), Loader=yaml.Loader)
+
+# override the environment variables
+database_url = os.getenv('SQLALCHEMY_DATABASE_URI')
+app.config['SQLALCHEMY_DATABASE_URI'] = config_obj['SQLALCHEMY_DATABASE_URI'] if database_url is None else database_url
+
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+
+db = SQLAlchemy(app)
+
+migrate = Migrate(app, db)

app/config.yaml

@@ -0,0 +1,2 @@
+#url: 'mysql://root@localhost:3306/sample_db?charset=utf8mb4'
+SQLALCHEMY_DATABASE_URI: 'postgresql://[email protected]:5433/testdb'

app/controllers/user_controller.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+from flask import Blueprint, jsonify, request
+import services.user_service as user_service
+from models.user import User
+from werkzeug.exceptions import HTTPException
+import json
+
+api = Blueprint('users', 'users')
+
+
+@api.route('/users', methods=['GET'])
+def api_get():
+    ''' Get all entities'''
+    users = user_service.get()
+    return jsonify([user.as_dict() for user in users])
+
+@api.route('/users', methods=['POST'])
+def api_post():
+    ''' Create entity'''
+    user = user_service.post(request.json)
+    return jsonify(user.as_dict())
+
+@api.route('/users/<string:id>', methods=['PUT'])
+def api_put(id):
+    ''' Update entity by id'''
+    body = request.json
+    body['id'] = id
+    res = user_service.put(body)
+    return jsonify(res.as_dict()) if isinstance(res, User) else jsonify(res)
+
+@api.route('/users/<string:id>', methods=['DELETE'])
+def api_delete(id):
+    ''' Delete entity by id'''
+    res = user_service.delete(id)
+    return jsonify(res)
+
+
+@api.errorhandler(HTTPException)
+def handle_exception(e):
+    """Return JSON format for HTTP errors."""
+    # start with the correct headers and status code from the error
+    response = e.get_response()
+    # replace the body with JSON
+    response.data = json.dumps({
+        'success': False,
+        "message": e.description
+    })
+    response.content_type = "application/json"
+    return response

app/models/user.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+from flask import Flask, jsonify, request
+from config import db
+import yaml
+import os
+
+
+class User(db.Model):
+    ''' The data model'''
+    # table name
+    __tablename__ = 'users'
+    id = db.Column(db.Integer(), primary_key=True, autoincrement=True)
+    handle = db.Column(db.String(200), nullable=False)
+    def as_dict(self):
+       return {c.name: getattr(self, c.name) for c in self.__table__.columns}

app/requirements.txt

@@ -0,0 +1,5 @@
+PyYAML==5.1.2
+Flask==1.1.1
+Flask-SQLAlchemy==2.4.1
+Flask-Migrate==2.5.2
+psycopg2==2.8.3

app/services/user_service.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+from models.user import User
+from config import db
+from werkzeug.exceptions import NotFound
+
+def get():
+    '''
+    Get all entities
+    :returns: all entity
+    '''
+    return User.query.all()
+
+def post(body):
+    '''
+    Create entity with body
+    :param body: request body
+    :returns: the created entity
+    '''
+    user = User(**body)
+    db.session.add(user)
+    db.session.commit()
+    return user
+
+def put(body):
+    '''
+    Update entity by id
+    :param body: request body
+    :returns: the updated entity
+    '''
+    user = User.query.get(body['id'])
+    if user:
+        user = User(**body)
+        db.session.merge(user)
+        db.session.flush()
+        db.session.commit()
+        return user
+    raise NotFound('no such entity found with id=' + str(body['id']))
+
+def delete(id):
+    '''
+    Delete entity by id
+    :param id: the entity id
+    :returns: the response
+    '''
+    user = User.query.get(id)
+    if user:
+        db.session.delete(user)
+        db.session.commit()
+        return {'success': True}
+    raise NotFound('no such entity found with id=' + str(id))
+
+
+

db/Dockerfile

@@ -0,0 +1,8 @@
+# Create from official postgres image
+FROM postgres
+
+# Add a database
+ENV POSTGRES_DB testdb
+
+# Initial db scripts
+COPY ./init-scripts /docker-entrypoint-initdb.d/

db/init-scripts/ddl.sql

@@ -0,0 +1,5 @@
+CREATE TABLE public.users (
+    id serial NOT NULL,
+    handle varchar(128) NOT NULL,
+    CONSTRAINT users_user_pkey PRIMARY KEY (id)
+);

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '2'
+services:
+  database:
+    build: db
+    restart: always
+    environment:
+      POSTGRES_DB: testdb
+      POSTGRES_PASSWORD: password
+  app:
+    build: app
+    depends_on: [database]
+    links:
+      - database
+    ports:
+      - "5000:5000"
+    environment:
+      SQLALCHEMY_DATABASE_URI: 'postgresql://postgres:password@database:5432/testdb'