10000 Merge branch 'task/updated-documentation' · python-microservices/pyms@9a5e5e2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9a5e5e2

Browse files
avara1986avara1986
committed
Merge branch 'task/updated-documentation'
2 parents 824cb5c + 2f15bfc commit 9a5e5e2

File tree

7 files changed

+161
-106
lines changed

7 files changed

+161
-106
lines changed

‎Pipfile

Lines changed: 1 addition & 0 deletions
< 10000 td data-grid-cell-id="diff-230078d672f10d17463a8a6265cad825b790885898256a3365be90685caac58d-29-30-2" data-line-anchor="diff-230078d672f10d17463a8a6265cad825b790885898256a3365be90685caac58dR30" data-selected="false" role="gridcell" style="background-color:var(--bgColor-default);padding-right:24px" tabindex="-1" valign="top" class="focusable-grid-cell diff-text-cell right-side-diff-cell left-side">
lightstep = "==4.3.0"
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ flake8 = "*"
2626
tox = "*"
2727
bandit = "*"
2828
mkdocs = "*"
29+
mkdocs-material = "*"
2930
3031

3132
[requires]

‎Pipfile.lock

Lines changed: 89 additions & 69 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Each microservice needs a config file in yaml or json format to work with it. Th
1212
the Flask settings of your project and the [Services](services.md). With this way to create configuration files, we
1313
solve two problems of the [12 Factor apps](https://12factor.net/):
1414
- Store config out of the code
15-
- Dev/prod parity: the configuration could be injected and not depends of our code, for example, Kubernetes config maps
15+
- Dev/prod parity: the configuration could be injected and not depends of our code, for example, Kubernetes configmaps
1616

1717
a simple configuration file could be a config.yaml:
1818

‎docs/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ microservices with Python which handles cross-cutting concerns:
1010
- Metrics
1111
- Distributed tracing
1212

13-
PyMS is powered by [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Connexion](https://github.com/zalando/connexion) and [Opentracing](https://opentracing.io/).
13+
PyMS is powered by [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Connexion](https://github.com/zalando/connexion)
14+
and [Opentracing](https://opentracing.io/).
1415

1516
Get started with [Installation](installation.md) and then get an overview with the [Quickstart](quickstart.md).
1617

@@ -35,16 +36,13 @@ microservices architecture.
3536
Nowadays, is not perfect and we have a looong roadmap, but we hope this library could help other felas and friends ;)
3637

3738

38-
## Index:
39+
## Index
3940
* [Installation](installation.md)
4041
* [Quickstart](quickstart.md)
4142
* [Configuration](configuration.md)
42-
* [Routing](routing.md)
4343
* [Services](services.md)
4444
* [PyMS structure](structure.md)
4545
* [Microservice class](ms_class.md)
46-
* [Quick start and examples](examples.md)
46+
* [Examples](examples.md)
47+
* [Routing](routing.md)
4748
* [Structure of a microservice project](structure_project.md)
48-
* Swagger and connexion
49-
* Tracing requests
50-
* [Services of PyMS](structure.md)

‎docs/ms_class.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ pyms:
3232
```
3333
Check [Configuration](configuration.md) section to know how to create a configuration file.
3434
35+
`Microservice` class search for a `config.yml` in the directory you pass in `path` parameter or search the file in
36+
`CONFIGMAP_FILE` env var.
37+
3538
Each keyword in our configuration block, can be accessed in our Microservice object through the attribute `config`.
3639

3740
```yaml

0 commit comments

Comments
 (0)
0