django-cfg 1.5.117

Modern Django framework with type-safe Pydantic v2 configuration, Next.js admin integration, real-time WebSockets, and 8 enterprise apps. Replace settings.py with validated models, 90% less code. Production-ready with AI agents, auto-generated TypeScript clients, and zero-config features.

Django-CFG: Type-Safe Django Configuration Framework

---

🚀 The Modern Django Framework for Enterprise Applications

Type-safe configuration • AI-Native Docs • Next.js Admin • gRPC Streaming • Real-time WebSockets • AI Agents • 8 Enterprise Apps

🎯 Live Demo • 📚 Documentation • 🤖 MCP Server • 🐙 GitHub

---

🎯 What is Django-CFG?

Django-CFG is a next-generation Django framework that replaces traditional settings.py with type-safe Pydantic v2 models. It eliminates runtime configuration errors, provides complete IDE autocomplete, and includes production-ready enterprise features out of the box.

Why Django-CFG?

Traditional Django problems:

• ❌ Runtime errors - configuration bugs discovered in production
• ❌ No IDE support - zero autocomplete, manual documentation lookup
• ❌ 200+ lines of unmaintainable settings.py
• ❌ Weeks of setup - for user auth, admin UI, payments, real-time features

Django-CFG solution:

• ✅ Startup validation - catch all config errors before deployment
• ✅ Full IDE autocomplete - IntelliSense for every setting
• ✅ 30 lines of code - 90% boilerplate reduction
• ✅ 30 seconds to production - everything included and ready

📚 Read the full comparison →

---

🚀 Quick Start

Requirements

• Python 3.12+ (required)
• pip or poetry

🚀 Quick Install

Interactive Installer (Recommended)

Visit our interactive installer page that automatically detects your operating system:

→ https://djangocfg.com/installer

The installer automatically:

• Detects your OS and architecture
• Downloads the correct Go binary installer
• Runs system checks (Python, Docker, Node.js, etc.)
• Installs missing dependencies
• Creates a complete project structure
• Configures environment files

One-Line Commands

Linux / macOS

curl -L https://djangocfg.com/install.sh | sh

Windows (PowerShell)

powershell -c "iwr https://djangocfg.com/install.ps1 | iex"

Note: If you get a PowerShell execution policy error, run PowerShell as Administrator and execute:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

📦 Manual Installation

# Create virtual environment with Python 3.12
python3.12 -m venv .venv && source .venv/bin/activate

# Install django-cfg and create project
pip3 install 'django-cfg[full]'
django-cfg create-project my_app

# Start the server
cd my_app/projects/django
poetry install
poetry run python manage.py runserver

What you get instantly:

• 🎨 Modern Admin UI → http://127.0.0.1:8000/admin/
• ⚡ Next.js Dashboard → Modern React admin interface
• 📡 Real-time WebSockets → Live updates with Centrifugo
• 🐳 Docker Ready → Production deployment configs
• 🖥️ Electron App → Desktop app template

Project structure:

my_app/
├── docker/              # Docker deployment
└── projects/
    ├── django/          # Django backend
    ├── frontend/        # Next.js frontend
    └── electron/        # Desktop app

Django-CFG startup with type-safe configuration validation

📚 Installation Guide →

Optional Features (Extras)

Install additional features based on your needs:

# Full installation (recommended for production)
pip3 install 'django-cfg[full]'

# Individual extras
pip3 install 'django-cfg[grpc]'        # gRPC microservices
pip3 install 'django-cfg[centrifugo]'  # Real-time WebSockets
pip3 install 'django-cfg[rq]'          # Background tasks with Redis Queue
pip3 install 'django-cfg[ai]'          # AI agents with Pydantic AI

# Combine multiple extras
pip3 install 'django-cfg[grpc,centrifugo,rq]'

Note: Quotes around extras are required for zsh compatibility.

Available extras:

• 🔄 [full] - All features (grpc + centrifugo + rq + ai)
• 🌐 [grpc] - gRPC server support (grpcio, grpcio-tools, protobuf)
• 📡 [centrifugo] - Real-time WebSocket integration (cent, websockets)
• 📋 [rq] - Redis Queue for background tasks (django-rq, rq-scheduler)
• 🤖 [ai] - AI agents framework (pydantic-ai)

---

Try Live Demo

See Django-CFG in action:

→ https://djangocfg.com/demo

Explore: Modern admin • Next.js dashboard • AI agents • Real-time updates • Support system

---

💡 Core Features

🔒 Type-Safe Configuration with Pydantic v2

Replace error-prone settings.py with validated Pydantic models.

Before: Django settings.py

# settings.py - Runtime errors, no validation
import os

DEBUG = os.getenv('DEBUG', 'False') == 'True'  # ❌ String comparison bug
DATABASE_PORT = os.getenv('DB_PORT', '5432')   # ❌ Still a string!

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': os.getenv('DB_NAME'),  # ❌ No validation until connection
        'PORT': DATABASE_PORT,          # ❌ Type mismatch in production
    }
}
# ... 200+ more lines

After: Django-CFG

# config.py - Type-safe, validated at startup
from django_cfg import DjangoConfig, DatabaseConfig

class MyConfig(DjangoConfig):
    """Production-ready type-safe configuration"""

    project_name: str = "My App"
    debug: bool = False  # ✅ Pydantic validates boolean

    # Type-safe database with startup validation
    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(
            name="${DB_NAME}",  # ✅ Validated at startup
            port=5432,          # ✅ Type-checked integer
        )
    }

Benefits:

• ✅ Pydantic v2 validation - catch errors before deployment
• ✅ Full IDE autocomplete - IntelliSense everywhere
• ✅ 90% less code - 200+ lines → 30 lines
• ✅ Type hints - mypy and pyright compatible

📚 Type-safe configuration guide →

---

⚛️ Next.js Admin Integration

Build modern admin interfaces with React - the only Django framework with built-in Next.js integration.

from django_cfg import DjangoConfig, NextJsAdminConfig

class MyConfig(DjangoConfig):
    # One line for complete Next.js admin!
    nextjs_admin: NextJsAdminConfig = NextJsAdminConfig(
        project_path="../admin",
    )

What you get:

• 🌐 Three-in-One Architecture - Public site + User dashboard + Admin panel in ONE Next.js project
• ⚙️ Dual Admin Strategy - Django Unfold (90% quick CRUD) + Next.js (10% complex features)
• ✨ Zero Configuration - Auto JWT auth, theme sync, TypeScript generation
• 📦 60% Smaller - ZIP deployment (~7MB vs ~20MB)
• ⚡ Auto-Detection - Dev mode automatically detected on ports 3000/3001

No migration needed - start with built-in admin, add Next.js when you need complex features!

📚 Next.js Admin Documentation →

---

📡 Real-Time WebSockets with Centrifugo

Production-ready WebSocket integration - live updates, notifications, and real-time collaboration.

from django_cfg import DjangoConfig, CentrifugoConfig

class MyConfig(DjangoConfig):
    # Enable real-time features
    centrifugo: CentrifugoConfig = CentrifugoConfig(
        enabled=True,
        api_url="http://localhost:8001/api",
    )

Built-in features:

• ⚡ Live Updates - Real-time data synchronization
• 🔔 Notifications - Push notifications to connected clients
• 👥 Presence - Track online users
• 💬 Chat - Real-time messaging out of the box
• 🔒 JWT Auth - Secure WebSocket connections

📚 Centrifugo Integration Guide →

---

🌐 gRPC Microservices & Streaming

Production-ready gRPC integration - bidirectional streaming, WebSocket bridge, and type-safe Protobuf.

from django_cfg.apps.integrations.grpc.services.centrifugo import (
    CentrifugoBridgeMixin,
    CentrifugoChannels,
    ChannelConfig,
)

# Define type-safe channel mappings
class BotChannels(CentrifugoChannels):
    heartbeat: ChannelConfig = ChannelConfig(
        template='bot#{bot_id}#heartbeat',
        rate_limit=5.0,  # Max once per 5 seconds
    )
    status: ChannelConfig = ChannelConfig(
        template='bot#{bot_id}#status',
        critical=True,  # Bypass rate limiting
    )

# gRPC service with automatic WebSocket publishing
class BotStreamingService(
    pb2_grpc.BotStreamingServiceServicer,
    CentrifugoBridgeMixin  # ← One-line WebSocket integration
):
    centrifugo_channels = BotChannels()
    
    async def ConnectBot(self, request_iterator, context):
        async for message in request_iterator:
            # Your business logic
            await process_message(message)
            
            # Auto-publish to WebSocket (1 line!)
            await self._notify_centrifugo(message, bot_id=bot_id)

Built-in features:

• 🔄 Bidirectional Streaming - Full-duplex gRPC communication
• 🌉 Centrifugo Bridge - Auto-publish gRPC events to WebSocket
• 🛡️ Circuit Breaker - Graceful degradation if Centrifugo unavailable
• 🔁 Auto Retry - Exponential backoff for critical events
• 📦 Dead Letter Queue - Never lose important messages
• ⚡ Rate Limiting - Per-channel throttling with critical bypass
• 🎯 Type-Safe Config - Pydantic v2 validation for channels

Architecture:

Trading Bot ──gRPC──> Django gRPC Service ──WebSocket──> Browser
                            ↓
                      [Business Logic]
                      [Database Save]
                      [Centrifugo Publish]

Why this approach?

• ✅ Django controls all business logic and validation
• ✅ Single source of truth for data transformations
• ✅ Graceful degradation - gRPC works even if WebSocket fails
• ✅ Production-ready resilience patterns built-in

📚 gRPC Integration Guide →

---

🤖 AI-Native Documentation

First Django framework with MCP server - Your AI coding assistant can access DjangoCFG docs instantly.

{
  "mcpServers": {
    "djangocfg-docs": {
      "url": "https://mcp.djangocfg.com/mcp"
    }
  }
}

Access documentation from anywhere:

# CLI search (fast, no Django required)
django-cfg search "database configuration"
django-cfg search "redis cache" --limit 3

# Python API
from django_cfg.modules.django_ai import search, get_docs
results = search("How to configure Redis cache?")

# REST API
curl 'https://mcp.djangocfg.com/api/search?q=database&limit=5'

Supported AI assistants:

• 🤖 Claude Desktop - Add MCP server to config
• 🖥️ Cursor IDE - Native MCP support
• 💬 ChatGPT - Via API integration
• 🔧 Any MCP Client - Universal protocol

📚 AI Documentation Guide →

---

🤖 AI Agents Framework

Built-in AI agent framework - LLM workflow automation with Django ORM integration.

from django_cfg import DjangoConfig

class MyConfig(DjangoConfig):
    # AI features (optional)
    openai_api_key: str = "${OPENAI_API_KEY}"
    anthropic_api_key: str = "${ANTHROPIC_API_KEY}"

    enable_agents: bool = True      # AI workflow automation
    enable_knowbase: bool = True    # Vector DB + RAG

Features:

• 🤖 AI Agents Framework - Type-safe LLM integration
• 📚 Vector Database - ChromaDB for semantic search
• 🔍 RAG - Retrieval-augmented generation
• 🎯 Pydantic AI - Validated AI input/output
• 🌐 Multi-LLM - OpenAI, Anthropic, Claude support

📚 AI Agents Guide →

---

📦 8 Enterprise Apps Included

Ship features in days, not months - production-ready apps out of the box:

App	Description	Time Saved
👤 Accounts	User management + OTP + SMS auth	3-4 weeks
🎫 Support	Ticketing system + SLA tracking	2-3 weeks
📧 Newsletter	Email campaigns + analytics	2-3 weeks
📊 Leads	CRM + sales pipeline	2-3 weeks
🤖 AI Agents	Workflow automation	3-4 weeks
📚 KnowBase	AI knowledge base + RAG	2-3 weeks
💳 Payments	Multi-provider payments	2-3 weeks
🔧 Maintenance	Multi-site management	1-2 weeks

Total time saved: 18+ months of development

class MyConfig(DjangoConfig):
    # Enable apps as needed (one line each!)
    enable_accounts: bool = True
    enable_support: bool = True
    enable_newsletter: bool = True
    enable_leads: bool = True
    enable_agents: bool = True
    enable_knowbase: bool = True
    enable_payments: bool = True
    enable_maintenance: bool = True

📚 Built-in Apps Overview →

---

🎨 Modern API UI with Tailwind 4

Beautiful browsable API - 88% smaller bundle, modern design.

• ✅ Glass morphism design
• ✅ Light/Dark/Auto themes
• ✅ Command palette (⌘K)
• ✅ 88% smaller (278KB → 33KB)
• ✅ Auto-generated TypeScript clients

📚 API Generation Guide →

---

🔄 Smart Multi-Database Routing

Zero-config database routing with automatic sharding:

from django_cfg import DjangoConfig, DatabaseConfig

class MyConfig(DjangoConfig):
    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(
            name="${DB_NAME}",
        ),
        "analytics": DatabaseConfig(
            name="${ANALYTICS_DB}",
            routing_apps=["analytics", "reports"],  # Auto-route!
        ),
    }

✅ Auto-routes read/write • ✅ Cross-DB transactions • ✅ Connection pooling

📚 Multi-Database Guide →

---

⚙️ Complete Configuration Example

All features in one DjangoConfig:

from django_cfg import DjangoConfig, DatabaseConfig, CacheConfig, NextJsAdminConfig

class ProductionConfig(DjangoConfig):
    # Project
    project_name: str = "My Enterprise App"
    secret_key: str = "${SECRET_KEY}"
    debug: bool = False

    # Next.js Admin (optional)
    nextjs_admin: NextJsAdminConfig = NextJsAdminConfig(
        project_path="../admin",
    )

    # Real-time WebSockets (optional)
    centrifugo: CentrifugoConfig = CentrifugoConfig(
        enabled=True,
    )

    # 8 Enterprise Apps (enable as needed)
    enable_accounts: bool = True      # User management
    enable_support: bool = True       # Ticketing
    enable_newsletter: bool = True    # Email campaigns
    enable_leads: bool = True         # CRM
    enable_agents: bool = True        # AI automation
    enable_knowbase: bool = True      # Vector DB
    enable_payments: bool = True      # Payments
    enable_maintenance: bool = True   # Site management

    # Infrastructure
    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(name="${DB_NAME}"),
    }
    caches: dict[str, CacheConfig] = {
        "default": CacheConfig(backend="redis"),
    }

    # AI Providers (optional)
    openai_api_key: str = "${OPENAI_API_KEY}"
    anthropic_api_key: str = "${ANTHROPIC_API_KEY}"

    # Integrations
    twilio_account_sid: str = "${TWILIO_ACCOUNT_SID}"
    stripe_api_key: str = "${STRIPE_API_KEY}"
    cloudflare_api_token: str = "${CF_API_TOKEN}"

📚 Configuration Reference →

---

📊 Comparison with Alternatives

Django-CFG vs Traditional Solutions

Feature	settings.py	django-environ	pydantic-settings	Django-CFG
Type Safety	❌ Runtime	⚠️ Basic	✅ Pydantic	✅ Full Pydantic v2
IDE Autocomplete	❌ None	❌ None	⚠️ Partial	✅ 100%
Startup Validation	❌ No	⚠️ Partial	✅ Yes	✅ Yes + Custom
Next.js Admin	❌ Manual	❌ None	❌ None	✅ Built-in
WebSocket (Centrifugo)	❌ Manual	❌ None	❌ None	✅ Built-in
Enterprise Apps	❌ Build all	❌ None	❌ None	✅ 8 included
AI Framework	❌ Manual	❌ None	❌ None	✅ Built-in
Setup Time	🟡 Weeks	🟡 Hours	🟡 Days	✅ 30 seconds
Config Lines	⚠️ 200+	⚠️ 150+	⚠️ 100+	✅ 30 lines

Legend: ✅ Excellent | 🟡 Requires Work | ⚠️ Partial | ❌ Not Available

📚 Detailed Comparison Guide →

---

📚 Documentation

🚀 Getting Started

• Installation - Quick setup
• First Project - Create your first app
• Configuration - Type-safe config
• Why Django-CFG? - Full comparison

⚛️ Next.js Integration

• Overview - Three-in-One architecture
• Core Concepts - Philosophy & design
• Quick Start - 5-minute setup
• Configuration - All options

📡 Real-Time & Microservices

• Centrifugo Integration - WebSocket setup
• Live Updates - Real-time data
• gRPC Streaming - Bidirectional streaming
• gRPC → WebSocket Bridge - Auto-publish to clients

🏗️ Core Features

• Built-in Apps - 8 enterprise apps
• API Generation - Auto TypeScript clients
• Database - Multi-DB routing
• Type Safety - Pydantic validation

🤖 AI Features

• AI-Native Docs - MCP server for AI assistants
• AI Agents - Workflow automation
• Creating Agents - Build custom agents
• Django Integration - ORM integration

🚀 Deployment

• Production Config - Best practices
• CLI Commands - 50+ commands

---

🤝 Community & Support

Resources

• 🌐 djangocfg.com - Official website & docs
• 🐙 GitHub - Source code & issues
• 💬 Discussions - Community support

Links

• 🎯 Live Demo - See it in action
• 📦 PyPI - Package repository
• 📚 Documentation - Complete guides

---

📄 License

MIT License - Free for commercial use

---

Made with ❤️ by the Django-CFG Team

---

Modern Django Framework • Type-Safe Configuration • AI-Native Docs • Next.js Admin • gRPC Streaming • Real-Time WebSockets

Django-CFG is the modern Django framework for enterprise applications. Built with Pydantic v2 for type-safe configuration, first Django framework with MCP server for AI assistants, includes Next.js admin integration, gRPC bidirectional streaming with WebSocket bridge, Centrifugo real-time support, AI agent framework, and 8 production-ready apps. Perfect for building scalable microservices and real-time Django applications with reduced boilerplate and enterprise features out of the box.

---

Get Started: Documentation • Live Demo • GitHub