README.md

python-backend-template

This is a multifunctional Python backend template

It provides:

• Dependency injection through dishka
• Specification pattern
• A convinient way to manage exception using global framework handler

The template is based on Uncle Bob's Clean Architecture approach.

Installation guide

• Install UV
• uv venv
• Activate venv
• Run uv sync
• To run the application in dev mode:
  • Use docker compose -p app -f deployment/docker-compose.local.yml up -d --build --remove-orphans to setup environment
  • Use uv run -m app
• To run the application in production mode, use Docker

Testing

If you use the original Clean Architecture approach, the application should be really easy to test.

• For testing the application, use make test
• If you want to see the test coverage, use make testcvg