Merge remote-tracking branch 'origin/master' into develop

avara1986 · avara1986 · commit adfab4d229b3 · 2019-11-18T19:29:28.000+01:00
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
 # microservices-scaffold
-Barebones Python Microservices
+Python Microservice Scaffold is an example of how to structure a Flask Microservice Project.
+This Scaffold is build over [PyMS](https://github.com/python-microservices/pyms) package. PyMS is a [Microservice chassis pattern](https://microservices.io/patterns/microservice-chassis.html)
+like Spring Boot (Java) or Gizmo (Golang). PyMS is a collection of libraries, best practices and recommended ways to build
+microservices with Python which handles cross-cutting concerns:
+- Externalized configuration
+- Logging
+- Health checks
+- Metrics (TODO)
+- Distributed tracing
 
 [![Build Status](https://travis-ci.org/python-microservices/microservices-scaffold.svg?branch=master)](https://travis-ci.org/python-microservices/microservices-scaffold)
 [![Coverage Status](https://coveralls.io/repos/github/python-microservices/microservices-scaffold/badge.svg?branch=master)](https://coveralls.io/github/python-microservices/microservices-scaffold?branch=master)
@@ -8,6 +16,19 @@ Barebones Python Microservices
 [![Python 3](https://pyup.io/repos/github/python-microservices/microservices-scaffold/python-3-shield.svg)](https://pyup.io/repos/github/python-microservices/microservices-scaffold/)
 
 
+# How to run the scaffold
+
+```bash
+virtualenv --python=python[3.6|3.7|3.8] venv
+source venv/bin/activate
+pip install -r requirements.txt
+python manage.py runserver
+```
+
+Open in your browser http://localhost:5000/template/ui/
+
+Read more info in the documentation page: 
+https://microservices-scaffold.readthedocs.io/en/latest/
 
 # Docker
 
@@ -27,7 +48,7 @@ Push to Kubernetes:
     
 ## How to contrib
 
-TODO
+See https://github.com/python-microservices/pyms/blob/master/CONTRIBUTING.md
 
 ### Update docs
 
diff --git a/config-docker.yml b/config-docker.yml
@@ -1,3 +1,9 @@
+pyms:
+  requests:
+    data: ""
+  swagger:
+    path: "swagger"
+    file: "swagger.yaml"
 ms:
   DEBUG: false
   TESTING: false
@@ -6,4 +12,4 @@ ms:
   SQLALCHEMY_TRACK_MODIFICATIONS: true
   SECRET_KEY: "gjr39dkjn344_!67#"
   DATABASE: db.sqlite3
-  SQLALCHEMY_DATABASE_URI: sqlite:////microservice/database/db.sqlite3
+  SQLALCHEMY_DATABASE_URI: sqlite:////microservice/database/db.sqlite3
diff --git a/config.yml b/config.yml
@@ -1,3 +1,9 @@
+pyms:
+  requests:
+    data: ""
+  swagger:
+    path: "swagger"
+    file: "swagger.yaml"
 ms:
   DEBUG: false
   TESTING: false
@@ -6,4 +12,4 @@ ms:
   SQLALCHEMY_TRACK_MODIFICATIONS: true
   SECRET_KEY: "gjr39dkjn344_!67#"
   DATABASE: db.sqlite3
-  SQLALCHEMY_DATABASE_URI: sqlite:////microservice/database/db.sqlite3
+  SQLALCHEMY_DATABASE_URI: sqlite:////tmp/db.sqlite3
diff --git a/docs/_static/aws_alias0.png b/docs/_static/aws_alias0.png
diff --git a/docs/_static/aws_alias1.png b/docs/_static/aws_alias1.png
diff --git a/docs/_static/aws_alias2.png b/docs/_static/aws_alias2.png
diff --git a/docs/_static/aws_environments.png b/docs/_static/aws_environments.png
diff --git a/docs/codeexample.rst b/docs/codeexample.rst
@@ -1,3 +1,4 @@
 Code Examples
 =============
 
+See simple examples in https://github.com/python-microservices/pyms/tree/master/examples
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -1,22 +1,15 @@
 Configuration
 =============
 
-The project is configured in `project/config.py`. You must set the project name `APP_NAME` and the path prefix
-of the project `APPLICATION_ROOT`. This constants is defined in the class Config:
-
-.. code-block:: python
-
-    class Config:
-        DEBUG = False
-        TESTING = False
-        APP_NAME = "Template"
-        APPLICATION_ROOT = "/template"
+Project configuration is loaded using py-ms package based on yml or json file.
+Some example files are config.yml, config-docker.yml and tests/config-tests.yml or see `PyMS configuration <https://py-ms.readthedocs.io/en/latest/configuration/>`_
 
 Documentation
 -------------
 The Microservice create a URL to inspect the Swagger documentation of the api in:
 
 .. code-block:: bash
+
     localhost:5000/[APPLICATION_ROOT]/ui/
 
 Our API Rest work with `connexion <http://connexion.readthedocs.io>`_. You can see connexion docs or the official
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,16 +4,28 @@
 
 Python Microservices
 ====================
+Python Microservice Scaffold is an example of how to structure a Flask Microservice Project.
+This Scaffold is build over `PyMS <https://github.com/python-microservices/pyms>`_ package. PyMS is a `Microservice chassis pattern <https://microservices.io/patterns/microservice-chassis.html>`_
+like Spring Boot (Java) or Gizmo (Golang). PyMS is a collection of libraries, best practices and recommended ways to build
+microservices with Python which handles cross-cutting concerns:
+
+* Externalized configuration
+* Logging
+* Health checks
+* Metrics (TODO)
+* Distributed tracing
+
 
 Stack
 -----
-* `connexion <http://connexion.readthedocs.io>`_
-* `Flask <https://github.com/pallets/flask>`_
+* `PyMS <https://github.com/python-microservices/pyms>`_
+   * `Flask <https://github.com/pallets/flask>`_
+   * `connexion <http://connexion.readthedocs.io>`_
+   * `Opentracing <https://github.com/opentracing-contrib/python-flask>`_
 * `SQLAlchemy <https://www.sqlalchemy.org/>`_
 * `Flask-SQLAlchemy <http://flask-sqlalchemy.pocoo.org/2.3/>`_
-* `Flask-Injector <https://github.com/alecthomas/flask_injector>`_
 * `Flask-Script <https://flask-script.readthedocs.io/en/latest/>`_
-* `Opentracing <https://github.com/opentracing-contrib/python-flask>`_
+
 
 
 Content
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -4,8 +4,16 @@ Installation
 Clone the project
 
 .. code-block:: bash
+
     git clone https://github.com/python-microservices/microservices-scaffold.git
 
+.. code-block:: bash
+
+    virtualenv --python=python[3.6|3.7|3.8] venv
+    source venv/bin/activate
+    pip install -r requirements.txt
+    python manage.py runserver
+
 Configure your project and the path of your MS. See :doc:`configuration </configuration>` section.
 
 Configure your setup.py with your project information
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -1,7 +1,26 @@
 Quickstart
 ==========
 
+Scaffold
+--------
+
+Clone and start this scaffold
+
 .. code-block:: bash
+
     git clone https://github.com/python-microservices/microservices-scaffold.git
     cd microservices-scaffold
+    virtualenv --python=python[3.6|3.7|3.8] venv
+    source venv/bin/activate
+    pip install -r requirements.txt
     python manage.py runserver
+
+
+Open in your browser http://localhost:8080/template/ui/
+
+Template
+--------
+
+You can create your own project from template:
+
+https://github.com/python-microservices/microservices-template
diff --git a/docs/structure.rst b/docs/structure.rst
@@ -5,24 +5,20 @@ You have a project with this structure:
 
 .. code-block:: bash
 
-   manager.py
+   Dockerfile
+   LICENSE
+   manage.py
+   config.yml
+   README.md
    requirements.txt
    requirements-tests.txt
    requirements-docker.txt
+   service.yaml
    setup.py
+   tests.sh
    tox.ini
-   myms
-   ├ healthcheck
-   │ └ healthcheck.py
-   ├ logger
-   │ └ logger.py
-   ├ models
-   │ └ __init__.py
-   └ tracer
-     └ main.py
    project
    ├ __init__.py
-   ├ config.py
    ├ models
    │ ├ __init__.py
    │ └ models.py
@@ -33,7 +29,8 @@ You have a project with this structure:
    └views
      ├ __init__.py
      └ views.py
-
+   docs/
+   tests/
 
 
 manager.py
@@ -51,43 +48,35 @@ You can set the host and the port with:
 
     python manage.py runserver -h 0.0.0.0 -p 8080
 
-Common Structure
+
+Common Libraries
 ----------------
 
-myms/healthcheck/healthcheck.py
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This views is usually used by Kubernetes, Eureka and other systems to check if our application is up and running
+py-ms is a library that contains a set of common features for microservices.
 
-myms/logger/logger.py
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Print logger in JSON format to send to server like Elasticsearch. Inject span traces in logger
+Structure of a project
+----------------------
 
-myms/models/__init__.py
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Initizalize `flask_sqlalchemy.SQLAlchemy object`
+For project configuration see :doc:`configuration </configuration>` section.
 
-myms/tracer/main.py
+project/models/init_db.py
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Create an injector `flask_opentracing.FlaskTracer` to use in our projects
+Initialize `flask_sqlalchemy.SQLAlchemy object`.
 
-Structure of a project
-----------------------
-
-project/__init__.py
-~~~~~~~~~~~~~~~~~~~
-This file init the project with the funcion `create_app`. Initialize the Flask app, register `blueprints <http://flask.pocoo.org/docs/0.12/blueprints/>`_
-and intialize all libraries like Swagger, database, the trace system...
+project/models/models.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Project specific models.
 
-project/config.py
-~~~~~~~~~~~~~~~~~
-See :doc:`configuration </configuration>` section
+project/swagger/swagger.yaml
+~~~~~~~~~~~~~
+Use to define your rest behaviour, endpoints and routes. See `connexion <http://connexion.readthedocs.io>`_ docs to how add new views.
 
 project/views
 ~~~~~~~~~~~~~
 use views.py or create your file.
 
-swagger/swagger.yaml
-~~~~~~~~~~~~~
-Use to define your rest behaviour, endpoints and routes. See `connexion <http://connexion.readthedocs.io>`_ docs to how add new views
-
+project/__init__.py
+~~~~~~~~~~~~~~~~~~~
+This file init the project calling `create_app` method. Initialize the Flask app, register `blueprints <http://flask.pocoo.org/docs/0.12/blueprints/>`_
+and initialize all libraries like Swagger, database, trace system, custom logger format, etc.
 
diff --git a/manage.py b/manage.py
@@ -1,7 +1,7 @@
 # encoding: utf-8
 from flask_script import Manager
 
-from project import create_app
+from project.app import create_app
 
 app = create_app()
 
diff --git a/project/__init__.py b/project/__init__.py
@@ -1,23 +1,3 @@
-from pyms.flask.app import Microservice
-
-from project.models.init_db import db
-
 __author__ = "Alberto Vara"
 __email__ = "a.vara.1986@gmail.com"
-__version__ = "0.3.1"
-
-
-class MyMicroservice(Microservice):
-    def init_libs(self, app):
-        db.init_app(app)
-        with app.test_request_context():
-            db.create_all()
-
-
-def create_app():
-    """Initialize the Flask app, register blueprints and intialize all libraries like Swagger, database, the trace system...
-    return the app and the database objects.
-    :return:
-    """
-    ms = MyMicroservice(service="ms", path=__file__)
-    return ms.create_app()
+__version__ = "1.0.0"
diff --git a/project/app.py b/project/app.py
@@ -0,0 +1,19 @@
+from pyms.flask.app import Microservice
+
+from project.models.init_db import db
+
+
+class MyMicroservice(Microservice):
+    def init_libs(self):
+        db.init_app(self.application)
+        with self.application.test_request_context():
+            db.create_all()
+
+
+def create_app():
+    """Initialize the Flask app, register blueprints and intialize all libraries like Swagger, database, the trace system...
+    return the app and the database objects.
+    :return:
+    """
+    ms = MyMicroservice(service="ms", path=__file__)
+    return ms.create_app()
diff --git a/requirements-docker.txt b/requirements-docker.txt
@@ -1,4 +1,4 @@
 -r requirements.txt
-gevent==1.3.7
+gevent==1.4.0
 gunicorn==19.9.0
-psutil==5.4.8
+psutil==5.6.3
diff --git a/requirements-tests.txt b/requirements-tests.txt
@@ -1,6 +1,6 @@
 -r requirements.txt
-coverage==4.5.2
-coveralls==1.5.1
+coveralls==1.8.2
+coverage==4.5.4
 nose==1.3.7
-pylint==2.1.1
-tox==3.5.3
+pylint==2.4.3
+tox==3.14.0
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,4 @@
-Flask-SQLAlchemy==2.3.2
-SQLAlchemy==1.2.14
+Flask-SQLAlchemy==2.4.1
+SQLAlchemy==1.3.10
 Flask-Script==2.0.6
-# py-ms==0.1.1
-git+https://github.com/python-microservices/pyms.git@master#egg=py-ms
-connexion[swagger-ui]==2.0.1
+py-ms==1.3.2
diff --git a/tests/config-tests.yml b/tests/config-tests.yml
@@ -1,3 +1,9 @@
+pyms:
+  requests:
+    data: ""
+  swagger:
+    path: "swagger"
+    file: "swagger.yaml"
 ms:
   DEBUG: false
   TESTING: true
@@ -6,4 +12,4 @@ ms:
   SQLALCHEMY_TRACK_MODIFICATIONS: true
   SECRET_KEY: "gjr39dkjn344_!67#"
   DATABASE: db_test.sqlite3
-  SQLALCHEMY_DATABASE_URI: sqlite:///db_test.sqlite3
+  SQLALCHEMY_DATABASE_URI: sqlite:///db_test.sqlite3
diff --git a/tests/test_views.py b/tests/test_views.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`Code Examples`
`2`	`2`	`=============`
`3`	`3`
	`4`	`+See simple examples in https://github.com/python-microservices/pyms/tree/master/examples`