OpenParable
Skip to content
← Back to skills

Django

Development
django

Django is an Agent Skill for development published in the microsoft/debugpy repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Best practices for Django web development including models, views, templates, and testing.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/microsoft/debugpy/blob/HEAD/.claude/skills/django/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/django, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Django

Best practices for Django web development including models, views, templates, and testing.

When to Use

Apply this skill when working with Django projects — models, views, URL routing, templates, forms, admin, and management commands.

Project Structure

  • Follow the standard Django app layout: models.py, views.py, urls.py, admin.py, tests.py, forms.py.
  • Keep each app focused on a single domain concept; avoid "god apps" with unrelated models.
  • Use settings/base.py, settings/dev.py, settings/prod.py for environment-specific configuration.

Models

  • Always define __str__ on models for admin and debugging readability.
  • Use Meta.ordering sparingly — it adds ORDER BY to every query. Prefer explicit .order_by() on querysets.
  • Use database indexes (db_index=True, Meta.indexes) for fields that appear in filter() / order_by().
  • Prefer CharField with choices (or TextChoices / IntegerChoices) over bare strings for constrained fields.
  • Use F() expressions and Q() objects for complex queries to avoid race conditions and improve readability.

Views

  • Prefer class-based views (CBVs) for CRUD; prefer function-based views for one-off logic.
  • Always explicitly set queryset or override get_queryset() — never rely on mutable class-level state.
  • Use select_related() and prefetch_related() to avoid N+1 query problems.
  • Set LOGIN_URL and use @login_required / LoginRequiredMixin consistently.

Testing

  • Use pytest-django with @pytest.mark.django_db for database access.
  • Prefer TestCase or TransactionTestCase only when explicit transaction control is needed; otherwise use pytest fixtures.
  • Use RequestFactory or Client to test views without starting a server.
  • Use baker.make() (model-bakery) or factories instead of manual model construction in tests.

Pitfalls

  • Never do blocking I/O in async views without wrapping in sync_to_async.
  • Avoid importing models at module level in settings.py or urls.py (circular imports).
  • Never store secrets in settings.py — use environment variables.
  • Avoid raw SQL unless the ORM genuinely cannot express the query.