77[ ![ Total alerts] ( https://img.shields.io/lgtm/alerts/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18 )] ( https://lgtm.com/projects/g/python-microservices/pyms/alerts/ )
88[ ![ Language grade: Python] ( https://img.shields.io/lgtm/grade/python/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18 )] ( https://lgtm.com/projects/g/python-microservices/pyms/context:python )
99
10- PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build
11- microservices with Python.
10+ PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build microservices with Python.
1211
1312## Documentation
1413
15- To know how use, install or build a project see the docs: https://py-ms.readthedocs.io/en/latest/
14+ To know how use, install or build a project see the [ docs] ( https://py-ms.readthedocs.io/en/latest/ ) .
1615
1716## Motivation
1817
1918When we started to create microservice with no idea, we were looking for tutorials, guides, best practices, but we found
2019nothing to create professional projects. Most articles say:
20+
2121- "Install flask"
2222- "Create routes"
2323- (Sometimes) "Create a swagger specs"
2424- "TA-DA! you have a microservice"
2525
26- But... what happens with our configuration out of code like Kubernetes configmap? what happens with transactionality?
26+ But... what happens with our configuration out of code like Kubernetes configmap? what happens with transactionality?
2727If we have many microservices, what happens with traces?.
2828
2929There are many problems around Python and microservices and we can`t find anyone to give a solution.
3030
31- We start creating these projects to try to solve all the problems we have found in our professional lives about
31+ We start creating these projects to try to solve all the problems we have found in our professional lives about
3232microservices architecture.
3333
34- Nowadays, is not perfect and we have a looong roadmap, but we hope this library could help other felas and friends ;)
34+ Nowadays, is not perfect and we have a looong roadmap, but we hope this library could help other felas and friends ;)
3535
36+ ## Installation
3637
37- ## Installation
3838``` bash
3939pip install py-ms
4040```
@@ -43,7 +43,8 @@ pip install py-ms
4343
4444You need to create 2 files: main.py and config.yml:
4545
46- main.py
46+ - ** main.py**
47+
4748``` python
4849from flask import jsonify
4950
@@ -62,9 +63,10 @@ if __name__ == '__main__':
6263 app.run()
6364```
6465
65- config.yml
66+ - ** config.yml**
67+
6668``` yaml
67- pyms :
69+ pyms :
6870 services : # 1.2
6971 requests :
7072 data : {}
@@ -77,19 +79,22 @@ pyms:
7779
7880### So what did that code do?
7981
80- 1. Create a instance of PyMS Microservice class (#1.1). This initialization inject the configuration defined in the
81- 1.3 block and could be accessed through current_app.config like typical
82- [Flask config](https://flask.palletsprojects.com/en/1.1.x/config/).
82+ 1. Create a instance of PyMS Microservice class (#1.1). This initialization inject the configuration defined in the
83+ 1.3 block and could be accessed through current_app.config like typical
84+ [Flask config](https://flask.palletsprojects.com/en/1.1.x/config/).
8385Then, initialize the service defined in the 1.2 block. See [Services](services.md) for more details.
84- 2. Initialize [Flask](https://flask.palletsprojects.com/en/1.1.x/) instance, [Connexion](https://github.com/zalando/connexion)
85- if it was defined in the pyms configuration block, create a tracer, add health-check blueprint, initialize libs and set
86- the PyMS Microservice in
87- ` ms` attribute and you can access to it with `current_app.ms`. This steps has their each functions and you can easy
86+
87+ 2. Initialize [Flask](https://flask.palletsprojects.com/en/1.1.x/) instance, [Connexion](https://github.com/zalando/connexion)
88+ if it was defined in the pyms configuration block, create a tracer, add health-check blueprint, initialize libs and set
89+ the PyMS Microservice in ` ms` attribute and you can access to it with `current_app.ms`.
90+ This steps has their each functions and you can easy
8891override it.
92+
89933. `create_app` return the flask instance and you can interact with it as a typical flask app
9094
91- See Documentation https://py-ms.readthedocs.io/en/latest/ to learn more.
95+ See [ Documentation]( https://py-ms.readthedocs.io/en/latest/) to learn more.
9296
9397# # How To Contrib
94- We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](COONTRIBUTING.md)
95- for more details
98+
99+ We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](CONTRIBUTING.md)
100+ for more details.
0 commit comments