First commit

Author: avara1986

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+include=
+    *project/*
+omit =
+    venv/*

.gitignore

@@ -99,3 +99,8 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+.idea
+
+pylintReport.txt
+db.sqlite3

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+sudo: false
+cache: false
+python:
+    - '3.6'
+install:
+  - pip install -r requirements-tests.txt
+
+script:
+  - coverage erase
+  - coverage run -m  unittest
+after_success:
+  - coverage combine
+  - coveralls
+
+notifications:
+  email:
+    - a.vara.1986@gmail.com

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.6.4-alpine3.7
+
+RUN apk add --update curl gcc g++ libffi-dev openssl-dev python3-dev \
+    && rm -rf /var/cache/apk/*
+RUN ln -s /usr/include/locale.h /usr/include/xlocale.h
+
+ENV PYTHONUNBUFFERED=1 ENVIRONMENT=pre APP_HOME=/microservice/
+
+RUN mkdir $APP_HOME
+WORKDIR $APP_HOME
+ADD requirement*.txt $APP_HOME
+RUN pip install -r requirements-docker.txt
+ADD . $APP_HOME
+
+EXPOSE 5000
+
+CMD ["gunicorn", "--worker-class", "eventlet", "--workers", "8", "--log-level", "INFO", "--bind", "0.0.0.0:5000", "manage:app"]

README.md

@@ -1,2 +1,23 @@
 # microservices-scaffold
 Barebones Python Microservices
+
+[![Build Status](https://travis-ci.org/python-microservices/microservices-scaffold.svg?branch=master)](https://travis-ci.org/python-microservices/microservices-scaffold)
+[![Build Status](https://coveralls.io/repos/github/python-microservices/microservices-scaffold/Badge.svg?branch=master)](https://coveralls.io/repos/github/python-microservices/microservices-scaffold)
+[![Build Status](https://requires.io/github/python-microservices/microservices-scaffold/requirements.svg?branch=master)](https://requires.io/github/python-microservices/microservices-scaffold/requirements/?branch=master)
+
+
+
+# Docker
+
+Create and push the image
+
+    docker build -t template -f Dockerfile .
+
+Test the image:
+
+    docker run -d -p 5000:5000 template
+    
+    
+Push to Kubernetes:
+
+    kubectl create -f service.yaml

manage.py

@@ -0,0 +1,24 @@
+# encoding: utf-8
+from flask_script import Manager
+
+from project import create_app
+
+app, db = create_app()
+
+manager = Manager(app)
+
+
+@manager.command
+def create_db():
+    """Creates the db tables."""
+    db.create_all()
+
+
+@manager.command
+def drop_db():
+    """Drops the db tables."""
+    db.drop_all()
+
+
+if __name__ == '__main__':
+    manager.run()

project/__init__.py

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+import os
+
+from flasgger import Swagger
+from flask import Flask
+
+from project.config import CONFIG
+
+__author__ = "Alberto Vara"
+__email__ = "a.vara.1986@gmail.com"
+__version__ = "0.0.1"
+
+ENVIRONMENT = os.environ.get("ENVIRONMENT", "default")
+
+SWAGGER_CONFIG = {
+    "headers": [
+    ],
+    "specs": [
+        {
+            "endpoint": 'apispec_1',
+            "route": '{application_root}/apispec_1.json',
+            "rule_filter": lambda rule: True,  # all in
+            "model_filter": lambda tag: True,  # all in
+        }
+    ],
+    "info": {
+        "title": "API ",
+        "description": "API para...",
+        "contact": {
+            "responsibleOrganization": "ME",
+            "responsibleDeveloper": "Me",
+            "email": "me@me.com",
+        },
+        "version": "0.0.1"
+    },
+    "securityDefinitions": {
+        "APIKeyHeader": {"type": "apiKey", "name": "Authorization", "in": "header"},
+    },
+    "static_url_path": "{application_root}/flasgger_static",
+    "swagger_ui": True,
+    "uiversion": 2,
+    "specs_route": "/apidocs/",
+    "basePath": "{application_root}"
+}
+
+
+class PrefixMiddleware(object):
+
+    def __init__(self, app, prefix=''):
+        self.app = app
+        self.prefix = prefix
+
+    def __call__(self, environ, start_response):
+
+        if environ['PATH_INFO'].startswith(self.prefix):
+            environ['PATH_INFO'] = environ['PATH_INFO'][len(self.prefix):]
+            environ['SCRIPT_NAME'] = self.prefix
+            return self.app(environ, start_response)
+        else:
+            start_response('404', [('Content-Type', 'text/plain')])
+            return ["This url does not belong to the app.".encode()]
+
+
+def create_app():
+    from project.models import db
+    from project.views import views_bp as views_blueprint
+    environment = os.environ.get("ENVIRONMENT", "default")
+
+    app = Flask(__name__)
+    app.config.from_object(CONFIG[environment])
+    app.wsgi_app = PrefixMiddleware(app.wsgi_app, prefix=app.config["APPLICATION_ROOT"])
+
+    db.init_app(app)
+
+    SWAGGER_CONFIG["specs"][0]["route"] = SWAGGER_CONFIG["specs"][0]["route"].format(
+        application_root=app.config["APPLICATION_ROOT"]
+    )
+    SWAGGER_CONFIG["static_url_path"] = SWAGGER_CONFIG["static_url_path"].format(
+        application_root=app.config["APPLICATION_ROOT"]
+    )
+    SWAGGER_CONFIG["specs_route"] = SWAGGER_CONFIG["specs_route"].format(
+        application_root=app.config["APPLICATION_ROOT"]
+    )
+    SWAGGER_CONFIG["basePath"] = SWAGGER_CONFIG["basePath"].format(
+        application_root=app.config["APPLICATION_ROOT"]
+    )
+    Swagger(app, config=SWAGGER_CONFIG)
+
+    app.register_blueprint(views_blueprint)
+    with app.test_request_context():
+        db.create_all()
+    return app, db

project/config.py

@@ -0,0 +1,53 @@
+# coding=utf-8
+import os
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+class Config:
+    """Default configuration for all environments"""
+
+    DEBUG = False
+    TESTING = False
+    APP_NAME = "Template"
+    APPLICATION_ROOT = "/template"
+    SQLALCHEMY_TRACK_MODIFICATIONS = True
+    SECRET_KEY = os.environ.get("SECRET_KEY") or "gjr39dkjn344_!67#"
+
+
+class TestConfig(Config):
+    """Configuration to run tests"""
+
+    DEBUG = True
+    TESTING = True
+    DATABASE = os.path.join(BASE_DIR, "db_test.sqlite3")
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(BASE_DIR, "db_test.sqlite3")
+
+
+class DevConfig(Config):
+    """Configuration to run in local environments"""
+
+    DEBUG = True
+    TESTING = True
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(BASE_DIR, "db.sqlite3")
+
+
+class PreConfig(Config):
+    """Configuration to run with docker and kubernetes in Preproduction"""
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(BASE_DIR, "db.sqlite3")
+
+
+class ProdConfig(Config):
+    """Configuration to run with docker and kubernetes in Production"""
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(BASE_DIR, "prod.db")
+
+
+CONFIG = {
+    "test": TestConfig,
+    "dev": DevConfig,
+    "pre": PreConfig,
+    "prod": ProdConfig,
+    "default": DevConfig
+}

project/models/__init__.py

@@ -0,0 +1,6 @@
+# encoding: utf-8
+from __future__ import absolute_import, print_function, unicode_literals
+
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()

project/models/models.py

@@ -0,0 +1,31 @@
+# encoding: utf-8
+from __future__ import absolute_import, print_function, unicode_literals
+
+import datetime
+
+from sqlalchemy import Column, Integer, String, DateTime
+
+from project.models import db
+
+
+def dump_datetime(value: datetime) -> list:
+    """Deserialize datetime object into string form for JSON processing."""
+    return [value.strftime("%Y-%m-%d"), value.strftime("%H:%M:%S")]
+
+
+class Colors(db.Model):
+    """Example model"""
+    __tablename__ = 'colors'
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    name = Column(String, nullable=False)
+    timestamp = Column(DateTime, default=datetime.datetime.now)
+
+    @property
+    def serialize(self) -> dict:
+        """Return object data in easily serializeable format"""
+        return {
+            'id': self.id,
+            'timestamp': dump_datetime(self.timestamp),
+            'name': self.name,
+        }