Tutorial 2: How To contribute, Create your own service

First, you must create a file with the name of your service inside of pyms.flask.service, for example, "myawesomesrv":

pyms/flask/services/myawesomesrv.py

from pyms.flask.services.driver import DriverService


class Service(DriverService):
    service = "myawesomesrv"
    default_values = {
        "myvalue": 0,
        "myvalue2": 1
    }

Now, you can configure your service from config.yml

pyms:
  services:
    myawesomesrv:
      myvalue: 5
      myvalue2: 5

All configuration in myawesomesrv (myvalue, myvalue2) is loaded in self.config: self.config.myvalue and self.config.myvalue2.

When you "call" an attribute of your service, DriverService searchs in self.config, and self.config contains the key-values that you've defined in your config.yaml for this service. Therefore, each key in your config.yaml is an attribute of your Service.

Your service will be instanced inside the ms object in flask.current_app object. For example, with the last config, you could print the folowing code:

from flask import jsonify, current_app

from pyms.flask.app import Microservice

ms = Microservice(service="my-minimal-microservice", path=__file__)
app = ms.create_app()


@app.route("/")
def example():
    return jsonify({
        "myvalue": current_app.ms.myawesomesrv.myvalue, 
        "myvalue2": current_app.ms.myawesomesrv.myvalue2
    })


if __name__ == '__main__':
    app.run()

This would be the output in http://localhost:5000/:

{"myvalue": 5, "myvalue2": 1}