https://github.com/inadarei/ms-python-flask-template

A template project for a Flask-based Python microservice
https://github.com/inadarei/ms-python-flask-template

docker flask microservice pytest python

Last synced: 17 days ago
JSON representation

A template project for a Flask-based Python microservice

• Host: GitHub
• URL: https://github.com/inadarei/ms-python-flask-template
• Owner: inadarei
• License: mit
• Created: 2020-05-22T03:08:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T21:41:04.000Z (over 1 year ago)
• Last Synced: 2024-04-14T07:48:06.482Z (7 months ago)
• Topics: docker, flask, microservice, pytest, python
• Language: Python
• Homepage:
• Size: 283 KB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ms-python-flask-template

A template project for a flask-based Python microservice

## Prerequisites:

1. Working Docker environment

2. GNU Make

## Supported Commands:

1. `make`  - build, start, and watch logs

2. `make start`

3. `make stop`

4. `make clean` - clean rebuild (for extreme debugging)

5. `make shell` - log into the running container of the microservice, for debugging

6. `make redis` - launch redis cli for debugging

7. `make logs` - tail combined logs from the service and the db

8. `make logs-app`

9. `make logs-db`

10. `make lint` - pylint code

11. `make test` - run unit and functional tests

12. `make add package="pytest"` - adds a module (in this case: "pytest") inside

a running container and saves it to the requirements.txt.