Devmons

This is implementation of homework given from Devmons/Crypkit

Assignment

The assignment was given in PDF file

Breakdown analysis

I analysed the assignment and decided to do the following things:

• Use FastAPI and python async
• Use SqlAlchemy and alembic
• Do a TDD with unit, acceptance and integration tests
• Describe in readme files all decisions
• Describe in readme files architecture and code design
• Use hexagonal architecture
• Use open telemetry for observability, with Prometheus, Grafana and add some dashboard
• Describe possible SLA, SLI, SLO
• Use github CI/CD pipelines
• Use ruff and mypy for linting
• Use conventional commits
• Use dockerfile with multistage and docker compose
• Write helm charts for kubernetes
• Generate openapi documentation using FastAPI
• Think about further improvements

Local setup

You need to install poetry and dependencies with it:

pip install poetry
poetry install

How to run tests

There are multiple test levels.

For unit tests you don't anything special. Just run them in you IDE.

For integration tests you need running compose, so run docker compose up --build -d before running them.

Further improvements

We can do:

• Implement acceptance tests
• Run integration and acceptance tests in github CI/CD using services
• Load testing with Locust
• Add authentication and authorization (for example with keycloack and JWT tokens)
• Add ratelimiting
• Add Graphql support and separate reading from writing (CQRS)
• Alternatives to background tasks (fast api background tasks / k8s cron jobs with entrypoints)
• Helm charts
• Use Terraform to describe what kind of infrastructure do we need
• Consider using separate classes for separate use-cases
• Use faker for faking data
• Use structured logging