Merge branch 'task/updated-documentation'

Author: avara1986

README.md

@@ -64,14 +64,15 @@ if __name__ == '__main__':
 
 config.yml
 ```yaml
-pyms: # 1.2
-  requests:
-    data: {}
-ms: # 1.3
-  DEBUG: true
-  APP_NAME: business-glossary
-  APPLICATION_ROOT : ""
-  SECRET_KEY: "gjr39dkjn344_!67#"
+pyms: 
+	services: # 1.2
+		requests:
+			data: {}
+	config: # 1.3
+		DEBUG: true
+		APP_NAME: business-glossary
+		APPLICATION_ROOT : ""
+		SECRET_KEY: "gjr39dkjn344_!67#"
 ```
 
 ### So what did that code do?

docs/configuration.md

@@ -18,91 +18,74 @@ a simple configuration file could be a config.yaml:
 
 ```yaml
 pyms:
-  requests: true
-  swagger:
-    path: ""
-    file: "swagger.yaml"
-my-ms:
-  DEBUG: true
-  TESTING: false
-  APP_NAME: "Python Microservice"
-  APPLICATION_ROOT: ""
+  services:
+		requests: true
+		swagger:
+			path: ""
+			file: "swagger.yaml"
+	config:
+		debug: true
+		testing: false
+		app_name: "Python Microservice"
+		APPLICATION_ROOT: ""
 ```
 
 or in a config.json:
 
 ```json
 {
-"pyms":{
-  "requests": true,
-  "swagger": {
-    "path": "",
-    "file": "swagger.yaml"
+  "pyms": {
+		"services":{
+			"requests": true,
+			"swagger": {
+				"path": "",
+				"file": "swagger.yaml"
+				}
+		},
+    "config": {
+      "DEBUG": true,
+      "TESTING": true,
+      "APP_NAME": "Python Microservice",
+      "APPLICATION_ROOT": "/",
+      "test_var": "general",
+      "subservice1": {
+        "test": "input"
+      },
+      "subservice2": {
+        "test": "output"
+      }
     }
-  },
-"my-ms": {
-  "DEBUG": true,
-  "TESTIN": false,
-  "APP_NAME": "Python Microservice",
-  "APPLICATION_ROOT": ""
   }
 }
 ```
 
 This file could contains this keywords:
 
-## pyms block
+## pyms - services block
 
 ```pyms```: all subsets inside this keyword are the settings of this library. Each keyword will be a service of our
 [Microservice class](ms_class.md). For example, we declare our microservice class as:
 
 ```python
 from pyms.flask.app import Microservice
-ms = Microservice(service="my-ms", path=__file__)
+ms = Microservice(path=__file__)
 ```
 and a `config.yaml` file:
 
 ```yaml
 pyms:
-  requests: true
+  services:
+		requests: true
 ```
 
 our object `ms` has an attribute `requests` that is a instance of our service [requests](services.md). 
 
-## Our microservice block
+## pyms - config block
 This part contains all keywords of a [Flask Configuration Handling](http://flask.pocoo.org/docs/1.0/config/) and our 
 constants of the enviroments (local configuration, staging configuration...). Keep in mind that a Flask configuration needs
-the keywords to be declared as uppercase.
+the keywords to be declared as uppercase. If you defined a variable like `app_name`, you will get this with 
+`current_app.config["APP_NAME"]`
 
-The name of this block is defined when you create the object of [Microservice class](ms_class.md):
-
-### Example 1
-```python
-from pyms.flask.app import Microservice
-ms = Microservice(service="my-personal-microservice", path=__file__)
-```
-and a `config.yaml` file:
-
-```yaml
-my-personal-microservice:
-  DEBUG: true
-  TESTING: false
-```
-
-### Example 2
-```python
-from pyms.flask.app import Microservice
-ms = Microservice(service="ms1-api", path=__file__)
-```
-and a `config.yaml` file:
-
-```yaml
-ms1-api:
-  DEBUG: true
-  TESTING: false
-```
-
-You can set this keyword with the environment var **CONFIGMAP_SERVICE**.
 
 ## Import Configuration
 With pyms, all configuration is stored as flask configuration and it can be acceded from:

docs/examples.md

@@ -7,24 +7,25 @@ pip install py-ms
 config.yml:
 
 ```yaml
-my-minimal-microservice:
-  APP_NAME: "Python Microservice"
+pyms:
+  config:
+    app_name: "Python Microservice"
 ```
 
 main.py
 
 ```python
-from flask import jsonify
+from flask import jsonify, current_app
 
 from pyms.flask.app import Microservice
 
-ms = Microservice(service="my-minimal-microservice", path=__file__)
+ms = Microservice(path=__file__)
 app = ms.create_app()
 
 
 @app.route("/")
 def example():
-    return jsonify({"main": "hello world"})
+    return jsonify({"main": "hello world {}".format(current_app.config["APP_NAME"])})
 
 
 if __name__ == '__main__':

docs/ms_class.md

@@ -10,7 +10,7 @@ from flask import jsonify
 
 from pyms.flask.app import Microservice
 
-ms = Microservice(service="my-minimal-microservice", path=__file__)
+ms = Microservice(path=__file__)
 app = ms.create_app()
 
 
@@ -26,21 +26,23 @@ if __name__ == '__main__':
 And a config file like this config.yml
 
 ```yaml
-my-minimal-microservice:
-  APP_NAME: "Python Microservice"
+pyms:
+	config:
+  	APP_NAME: "Python Microservice"
 ```
 Check [Configuration](configuration.md) section to know how to create a configuration file.
 
 Each keyword in our configuration block, can be accessed in our Microservice object through the attribute `config`.
 
 ```yaml
 # Config.yml
-example-config:
-  APP_NAME: "Python Microservice"
-  foo: "var"
-  multiplevars:
-    config1: "test1"
-    config2: "test2"
+pyms:
+	config:
+		app_name: "Python Microservice"
+		foo: "var"
+		multiplevars:
+			config1: "test1"
+			config2: "test2"
   
 ```
 ```python
@@ -50,6 +52,8 @@ from pyms.flask.app import Microservice
 ms = Microservice(service="example-config", path=__file__)
 print(ms.config.APP_NAME) 
 # >> "Python Microservice"
+print(ms.config.app_name) 
+# >> "Python Microservice"
 print(ms.config.foo) 
 # >> "bar"
 print(ms.config.multiplevars.config1) 

docs/quickstart.md

@@ -25,14 +25,15 @@ if __name__ == '__main__':
 
 config.yml
 ```yaml
-pyms: # 1.2
-  requests:
-    data: {}
-ms: # 1.3
-  DEBUG: true
-  APP_NAME: business-glossary
-  APPLICATION_ROOT : ""
-  SECRET_KEY: "gjr39dkjn344_!67#"
+pyms: 
+	services: # 1.2
+		requests:
+			data: {}
+	config: # 1.3
+		DEBUG: true
+		APP_NAME: business-glossary
+		APPLICATION_ROOT : ""
+		SECRET_KEY: "gjr39dkjn344_!67#"
 ```
 
 ## So what did that code do?

docs/services.md

@@ -48,7 +48,8 @@ To use this service, you may add the next to you configuration file:
 
 ```yaml
 pyms:
-  metrics: true
+  services:
+		metrics: true
 ```
 
 This will add the endpoint `/metrics` to your microservice, which will expose
@@ -75,8 +76,9 @@ class Service(DriverService):
 * Now, you can configure your service from `config.yml`
 ```yaml
 pyms:
-  myawesomesrv:
-    myvalue: 5
+	config:
+		myawesomesrv:
+			myvalue: 5
 ```
 
 * Your service will be setted inside `ms` object in `flask.current_app` objetct. for example, with the last config,