https://github.com/python-microservices/microservices-scaffold
Barebone Python Microservices with Flask
https://github.com/python-microservices/microservices-scaffold
barebones-python-microservices flask hacktoberfest microservice-example microservices microservices-scaffold pyms python python-microservices python3
Last synced: 2 months ago
JSON representation
Barebone Python Microservices with Flask
- Host: GitHub
- URL: https://github.com/python-microservices/microservices-scaffold
- Owner: python-microservices
- License: gpl-3.0
- Created: 2018-03-24T14:12:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-07T21:00:14.000Z (almost 3 years ago)
- Last Synced: 2023-11-07T16:17:45.832Z (about 2 years ago)
- Topics: barebones-python-microservices, flask, hacktoberfest, microservice-example, microservices, microservices-scaffold, pyms, python, python-microservices, python3
- Language: Python
- Homepage: https://python-microservices.github.io/scaffold/
- Size: 943 KB
- Stars: 161
- Watchers: 12
- Forks: 47
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# microservices-scaffold
[](https://travis-ci.org/python-microservices/microservices-scaffold)
[](https://coveralls.io/github/python-microservices/microservices-scaffold?branch=master)
[](https://requires.io/github/python-microservices/microservices-scaffold/requirements/?branch=master)
[](https://pyup.io/repos/github/python-microservices/microservices-scaffold/)
[](https://pyup.io/repos/github/python-microservices/microservices-scaffold/)
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
- Distributed tracing
## Quickstart
We recommended use [Poetry](https://python-poetry.org/docs/) to install the dependencies
Start with poetry
```shell
pip install --user poetry
poetry update
poetry run python manage.py
```
Start with a virtualenv
```shell
pip install -r requirements.txt
python manage.py
```
Open `http://127.0.0.1:5000/ui/` and play with swagger
See our [quickstart webpage](https://python-microservices.github.io/scaffold/quickstart/)
# Dependencies
Updated dependencies in a requirements.txt with:
```shell
poetry export --dev -f requirements.txt --output requirements.txt
```
# How To contribute
We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](CONTRIBUTING.md)
for more details