3.2. ADR Example

  • Decision: Python backend web framework

  • Status: accepted

  • Decision Date: 2000-01-02

  • Release Date: 2000-01-05

  • Deciders: Mark Watney, Melissa Lewis, Rick Martinez

3.2.1. Problem

  • Python backend web framework is needed

3.2.2. Motivation

  • Codebase become unmaintainable

  • Current documentation in old

  • Need API documentation auto-generation

  • Need REST/JSON API

  • Need authorization and authentication

  • Need auto-generated admin panel

  • Need tests

  • Need ORM

  • Need auto-generated database migrations

  • Need async code

  • Need more time-effective way for on-boarding of new employees

  • Onboarding takes too much time

  • ORM makes refactoring easier

  • ORM standardizes data model

3.2.3. Considerations

  • FastAPI

  • Flask

  • Django + Ninja

Source: https://lp.jetbrains.com/python-developers-survey-2022/#FrameworksLibraries

3.2.4. Option 1 - FastAPI

  • Good: Easy

  • Good: Fast onboarding

  • Good: Async

  • Good: API documentation auto-generation

  • Good: Worldwide adoption (on hype)

  • Bad: New project

  • Bad: No ORM

  • Bad: No DB schema migration

  • Bad: No admin

  • Bad: Single-person driven project (single point of failure)

  • Bad: No steering committee

  • Bad: Slowed down recently

  • Decision: rejected, no ORM

3.2.5. Option 2 - Flask

  • Good: Easy

  • Good: Fast onboarding

  • Good: ORM (as separate package)

  • Good: Mature project

  • Good: Async since 2.0

  • Bad: FastAPI took his hype

  • Bad: No DB schema migration

  • Bad: No admin

  • Bad: No API documentation auto-generation

  • Decision: rejected, obsolete?

3.2.6. Option 3 - Django + Ninja

  • Good: Async

  • Good: ORM

  • Good: DB schema migration

  • Good: Admin

  • Good: API documentation auto-generation (Ninja)

  • Good: FastAPI style REST/JSON views (Ninja)

  • Good: Steering committee (no single point of failure)

  • Bad: Intermediate

  • Bad: More complex than FastAPI and Flask

  • Decision: candidate

3.2.7. Decision

  • Django + Ninja

Django framework is a first class citizen and well known framework in Python community. Ninja adds FastAPI style views to Django and automatically generates documentation in OpenAPI format. Django has ORM, database schema migration and admin panel. Django supports asynchronous code. Good community support big players included (Instagram, Youtube).

3.2.8. References