netologist / python-service-scaffold

Clean Architecture Python Service Scaffold

User Service

Pre-requirements

Install Poetry

pip install --user poetry
poetry install

Run Server

make start

Run Tests

make test

Run Format

make format

Run Linter

make flake8

Run Code Checker

make mypy

Build Docker Image

make docker.build

or

make docker.build-no-cache

DB Migrations

make db.migrate

or

make db.makemigrations

Folder Structure in the User Service Module

This project uses clean architecture pattern for folder structure.

Flow of control

Architecture overview

Infrastructure

infrastructure is for infrastructure adapters like database, salesforce, observability, etc.

Domain

domain is for domain objects like entities, value objects, repositories etc.

Application

application is for application objects like use cases, converters etc.

User Interfaces

interfaces is for user interfaces like cli, graphql, rest api etc.

Folder Structure for Tests

• Unit Tests
• E2E Tests