Backend · Any coding agent
Django 6 & Ninja / DRF ARCHITECTURE.md
An ARCHITECTURE.md for Django 6 & Ninja / DRF: module responsibilities, data flow and the boundaries code changes must keep.
- Path
- ARCHITECTURE.md
- Loads
- Read when referenced
- Format
- Markdown (.md)
- Used by
- Any coding agent
What this file tells the agent
ARCHITECTURE.md describes module responsibilities, state boundaries and data flow, so a coding agent knows where code belongs before it changes anything. Point to it from CLAUDE.md or AGENTS.md so agents read it.
- Use asynchronous ORM operations (aget(), acreate(), afirst()) inside async def view handlers.
- Prevent N+1 query catastrophes: always apply select_related() for ForeignKey/OneToOne and prefetch_related() for ManyToMany/reverse relationships.
- Enforce Django Ninja schemas or DRF serializers with explicit field typing; never return raw unvalidated model instances.
- Never alter existing committed migration files; generate new sequential migrations via python manage.py makemigrations.
- Use GeneratedField for computed database columns rather than redundant model save() recalculations.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
# Discouraged: Synchronous blocking query inside async context & N+1 queries
@router.get("/articles/{article_id}")
async def get_article(request, article_id: int):
article = Article.objects.get(id=article_id) # Synchronous blocking call!
return {"id": article.id, "title": article.title, "author": article.author.username} # N+1 DB hit!from ninja import Router, Schema
from django.shortcuts import aget_object_or_404
from .models import Article
router = Router()
class ArticleOut(Schema):
id: int
title: str
author_name: str
@router.get("/articles/{article_id}", response=ArticleOut)
async def get_article(request, article_id: int):
# Asynchronous fetch with joined relationship preventing N+1
article = await Article.objects.select_related("author").aget(id=article_id)
return {
"id": article.id,
"title": article.title,
"author_name": article.author.username,
}Install it in one command
- 01
Go to your project root
The file goes at ARCHITECTURE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Agents read it when your CLAUDE.md or AGENTS.md points to it. Add a line such as "Read ARCHITECTURE.md before structural changes".
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/architecture-md/python-django" -o "ARCHITECTURE.md"
writes ARCHITECTURE.md
ARCHITECTURE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Django 6 & Ninja / DRF
Questions
- What belongs in ARCHITECTURE.md?
- How the main modules relate, how state and data flow, and the boundaries every change must keep.
- How does ARCHITECTURE.md help AI agents?
- It tells them where code belongs and which boundaries to keep, so they are less likely to add circular dependencies or skip layers. Point to it from CLAUDE.md or AGENTS.md so they read it.