Django Getting Started

Installation

pip install drogue[django]

Basic Usage

# settings.py
from drogue.adapters.django import DrogueRateLimiter

DROGUE_LIMITER = DrogueRateLimiter(default_limits=["100/minute"])

MIDDLEWARE = [
    # ... existing middleware
    "drogue.adapters.django.DrogueMiddleware",
]

# views.py
from django.http import JsonResponse
from drogue.adapters.django import DrogueRateLimiter

limiter = DROGUE_LIMITER

@limiter.limit("10/minute")
def get_data(request):
    return JsonResponse({"data": "value"})

Configuration

# settings.py
from drogue.adapters.django import DrogueRateLimiter
from drogue.core.config import DrogueConfig

config = DrogueConfig(
    default_algorithm="token_bucket",
    ban_enabled=True,
    ddos_enabled=True,
)

DROGUE_LIMITER = DrogueRateLimiter(
    config=config,
    default_limits=["100/minute"],
)

MIDDLEWARE = [
    # ... existing middleware
    "drogue.adapters.django.DrogueMiddleware",
]

Behind a Reverse Proxy

Configure trusted_proxies in your settings:

# settings.py
from drogue.core.config import DrogueConfig

config = DrogueConfig(
    trusted_proxies=["10.0.0.0/8", "172.16.0.0/12"],
    proxy_header="x-forwarded-for",
    trust_x_real_ip=True,
)

DROGUE_LIMITER = DrogueRateLimiter(
    config=config,
    default_limits=["100/minute"],
)

Security note: Without trusted_proxies configured, X-Forwarded-For and X-Real-IP headers are completely ignored. Clients cannot spoof their identity by sending these headers directly.

Per-View Limits

from django.http import JsonResponse
from drogue.adapters.django import DrogueRateLimiter

limiter = DROGUE_LIMITER

@limiter.limit("100/minute")
def public_view(request):
    return JsonResponse({"data": "public"})

@limiter.limit("10/minute")
def private_view(request):
    return JsonResponse({"data": "private"})

Middleware for Global Limits

The DrogueMiddleware applies global rate limits to all views:

MIDDLEWARE = [
    # ... existing middleware
    "drogue.adapters.django.DrogueMiddleware",
]

Redis Backend

# settings.py
from drogue.core.storage.redis import RedisStorage

storage = RedisStorage(url="redis://localhost:6379")

DROGUE_LIMITER = DrogueRateLimiter(
    storage=storage,
    default_limits=["100/minute"],
)

Async Views

from django.http import JsonResponse
from drogue.adapters.django import DrogueRateLimiter

limiter = DROGUE_LIMITER

@limiter.limit("10/minute")
async def async_view(request):
    return JsonResponse({"data": "async"})