Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/euiyounghwang/python-flask-basic
python-flask-basic
https://github.com/euiyounghwang/python-flask-basic
alembic docker docker-compose elasticsearch flask flask-connexion kafka kafka-consumer kafka-producer poetry pytest python3 rabbitmq rabbitmq-consumer rest-api-framework restapi-framework shell-script swagger swagger-ui thread
Last synced: about 2 months ago
JSON representation
python-flask-basic
- Host: GitHub
- URL: https://github.com/euiyounghwang/python-flask-basic
- Owner: euiyounghwang
- Created: 2024-01-26T17:14:51.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-02-28T01:29:25.000Z (10 months ago)
- Last Synced: 2024-02-28T03:41:15.745Z (10 months ago)
- Topics: alembic, docker, docker-compose, elasticsearch, flask, flask-connexion, kafka, kafka-consumer, kafka-producer, poetry, pytest, python3, rabbitmq, rabbitmq-consumer, rest-api-framework, restapi-framework, shell-script, swagger, swagger-ui, thread
- Language: Python
- Homepage:
- Size: 259 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python-flask-basic
Connexion is a modern Python web framework (build & install a enviroment using this script `source ./create_virtual_env.sh`) that makes spec-first and api-first development easy. You describe your API in an OpenAPI (or swagger) specification with as much detail as you want and Connexion will guarantee that it works as you specified. (It's very useful tool to build a number of schemas for database, https://dbdiagram.io/d/65b83f0bac844320aefd041e)
- It can be test a few function as background job (a process that runs in the background, `https://github.com/euiyounghwang/python-flask-basic/blob/master/job/job.py`) in your API
- Indexing Kafka message into Elasticsearch through thread in Restful API: https://github.com/euiyounghwang/python-flask-basic/blob/master/job/kafka_job.py#L35
- Create message using this shell script `./create-topic-run.sh, ./create-topic-got.sh, ./create-rabbitmq-run.sh, ./create-rabbitmq-got.sh` based on Kafka, Rabbitmq
Based on your specification, Connexion provides the following functionality:
- Automatic routing to your Python functions
- Authentication
- Request validation
- Parameter parsing and injection
- Response serialization
- Response validation
- A Swagger UI console with live documentation and ‘try it out’ feature
__Waitress__(`pip install waitress`) (https://pypi.org/project/waitress/) is a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones which live in the Python standard library
docker exec -it kafka-cluster-kafka-1-1 kafka-topics --bootstrap-server=localhost:9092 --topic test-topic --delete --group Fastapi
Created topic test-topic.
#### Install Poerty
```bash
https://python-poetry.org/docs/?ref=dylancastillo.co#installing-with-the-official-installer
```
#### Using Python Virtual Environment
```bash
python -m venv .venv
source .venv/bin/activate
# Migrate
alembic init alembic
alembic revision -m "first migrations"
alembic upgrade head
# new revision add
$> alembic revision
$> alembic revision -m "message" # add message
# write revistion after detecting the changes from alembic
$> alembic revision --autogenerate
$> alembic revision --autogenerate -m "message"
```
#### Using Poetry: Create the virtual environment in the same directory as the project and install the dependencies with basic library:
```bash
poetry config virtualenvs.in-project true
poetry init
poetry add uvicorn
poetry add pytest
poetry add "connexion[swagger-ui]"
poetry add "connexion[flask]"
poetry add "connexion[swagger-ui]"
```
#### Handling with different user for github when pushing the commit
```bash
(.venv) ➜ python-flask-basic git:(master) git push -u origin master
remote: Permission to euiyounghwang/python-flask-basic.git denied to euiyounghwang1.
fatal: unable to access 'https://github.com/euiyounghwang/python-flask-basic.git/': The requested URL returned error: 403
(.venv) ➜ python-flask-basic git:(master) git config --local credential.helper ""
```
#### Run Service
```bash
http://localhost:5000/api/ui/
```
#### Push Docker-io with my account
```bash
docker login -u "euiyoung" -p "" docker.io
docker push euiyoung/fn-flask-basic-api:es
(.venv) ➜ python-elasticsearch git:(master) docker push euiyoung/fn-flask-basic-api:es
The push refers to repository [docker.io/euiyoung/fn-flask-basic-api]
5d647ec1a1fb: Pushed
fd06eaaba40d: Pushed
64affd5054b0: Pushed
0d9bf610013e: Pushed
ddb6a9981c5b: Pushed
91f013cc9ad4: Pushed
1d228a5c814d: Pushed
96241174affd: Pushed
174a3bb9cb52: Pushed
f69e96eb5a0c: Pushed
44ea9a923069: Pushed
4b9bc13fb5b2: Pushed
c9f974dacf48: Pushed
cdc9dae211b4: Pushed
7095af798ace: Pushed
fe6a4fdbedc0: Pushed
e4d0e810d54a: Pushed
4e006334a6fd: Pushed
es: digest: sha256:1154c1125dca43ae585f45af4bf0df9374eecf05ab35d3fb9ac5131e97b0ce22 size: 4101
```
### Swagger for REST-API
### Pytest
- Docker with py.test
```bash
fn-flask-basic-api-test
euiyoung/fn-flask-basic-api:test
76ff0f2223a2
15001:5001
2024-01-27 22:23:54 ============================= test session starts ==============================
2024-01-27 22:23:54 platform linux -- Python 3.6.13, pytest-7.0.1, pluggy-1.0.0 -- /usr/local/bin/python
2024-01-27 22:23:54 cachedir: .pytest_cache
2024-01-27 22:23:54 rootdir: /app/FN-BEES-Services/tests, configfile: pytest.ini
2024-01-27 22:23:54 plugins: cov-4.0.0, mock-3.6.1
2024-01-27 22:23:54 collecting ... collected 1 item
2024-01-27 22:23:54
2024-01-27 22:23:55 tests/test_api.py::BaseTestAliveController::test_get_restful PASSED [100%]
2024-01-27 22:23:55
2024-01-27 22:23:55 ============================== 1 passed in 1.05s ===============================
```
- Go to virtual enviroment using `source .venv/bin/activate`
- Run this command manually: `poetry run py.test -v --junitxml=test-reports/junit/pytest.xml --cov-report html --cov tests/` or `./pytest.sh`
```bash
(.venv) ➜ python-flask-basic git:(master) ./pytest.sh
======================================================================== test session starts =========================================================================
platform darwin -- Python 3.9.7, pytest-7.0.1, pluggy-1.4.0 -- /Users/euiyoung.hwang/ES/Python_Workspace/python-flask-basic/.venv/bin/python
cachedir: .pytest_cache
rootdir: /Users/euiyoung.hwang/ES/Python_Workspace/python-flask-basic/tests, configfile: pytest.ini
plugins: mock-3.6.1, cov-4.0.0
collected 1 item
tests/test_api.py::BaseTestAliveController::test_get_restful PASSED [100%]
---------- coverage: platform darwin, python 3.9.7-final-0 -----------
Name Stmts Miss Cover Missing
----------------------------------------------------------------
api/__init__.py 42 1 98% 58
api/controller/__init__.py 0 0 100%
api/controller/api_controller.py 48 31 35% 20-23, 28-39, 44-52, 56-64
api/repository/__init__.py 0 0 100%
api/repository/model.py 10 0 100%
api/repository/repo.py 43 27 37% 13-18, 21-26, 37-44, 47-53, 56-58
api/repository/schema.py 6 0 100%
config/__init__.py 0 0 100%
config/log_config.py 32 1 97% 42
tests/__init__.py 12 1 92% 16
tests/conftest.py 16 8 50% 10-13, 19-24
tests/test_api.py 10 1 90% 16
----------------------------------------------------------------
TOTAL 219 70 68% [100%]
```