Skip to content

toriium/api-model-python

Repository files navigation

api-library

Built With:

System Requirements

  • python ^3.11
  • docker
  • poetry

URLS

https://localhost/health_check API
https://grafana.localhost Grafana

How to run the app (Production)

  make run

How to debug app

  make run_local
  python src/main.py

How to run pre-commit

pre-commit install 
pre-commit autoupdate

How to run tests

Install test tools

  sudo apt install inotify-tools

Install Allure

  wget https://github.com/allure-framework/allure2/releases/download/2.33.0/allure_2.33.0-1_all.deb
  sudo dpkg -i allure_2.33.0-1_all.deb

Test Commands

1 - make run_dev
2 - make test

Layers

  • domain: All main entities of the system
  • application: All business logic
  • data: All parts that interact with data, API, Cache, SQL, etc...
  • presentation: How the system will be available, API, CLI, message-broker, etc...

Notes

  • It is using gunicorn because automatic instrumentations does not work with multi workers on uvicorn

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors