@djangocfg/api

---

What is Django-CFG?

Django-CFG is a next-generation Django framework that replaces settings.py with type-safe Pydantic v2 models. Catch configuration errors at startup, get full IDE autocomplete, and ship production-ready features in 30 seconds instead of weeks.

Why Django-CFG?

• Type-safe config - Pydantic v2 validation catches errors before deployment
• 90% less code - Replace 200+ line settings.py with 30 lines
• Typed API clients - Generate TypeScript / Python / Go clients from your DRF OpenAPI schema
• Real-time WebSockets - Centrifugo integration included
• gRPC streaming - Bidirectional streaming with WebSocket bridge
• AI-native docs - First Django framework with MCP server for AI assistants
• 8 enterprise apps - Save 18+ months of development

---

Quick Start

One-Line Install

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

# Windows (PowerShell)
powershell -c "iwr https://djangocfg.com/install.ps1 | iex"

Manual Install

pip install 'django-cfg[full]'
django-cfg create-project my_app
cd my_app/projects/django
poetry run python manage.py runserver

What you get instantly:

• Django Admin (Unfold) → http://127.0.0.1:8000/admin/
• Real-time WebSockets → Live updates
• Auto-generated API clients → TypeScript / Python / Go
• Docker Ready → Production configs
• Electron App → Desktop template

→ Full Installation Guide

---

Configuration Example

Before: settings.py

# 200+ lines of untyped configuration
DEBUG = os.getenv('DEBUG', 'False') == 'True'  # ❌ Bug waiting to happen
DATABASE_PORT = os.getenv('DB_PORT', '5432')   # ❌ Still a string!

After: Django-CFG

from django_cfg import DjangoConfig, DatabaseConfig

class MyConfig(DjangoConfig):
    project_name: str = "My App"
    debug: bool = False  # ✅ Type-safe

    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(
            name="${DB_NAME}",  # ✅ Validated at startup
            port=5432,          # ✅ Correct type
        )
    }

Full IDE autocomplete • Startup validation • Zero runtime errors

---

Features

Type-Safe Configuration

Pydantic v2 models replace error-prone settings.py - catch bugs before deployment.

Typed API Client Generation

Generate fully-typed TypeScript, Python, and Go clients straight from your DRF OpenAPI schema — no hand-written API code, no drift between backend and frontend.

python manage.py gen          # generate clients from the live OpenAPI schema
python manage.py gen --ts     # TypeScript only

Real-Time WebSockets

Production-ready Centrifugo integration - live updates, notifications, presence tracking.

gRPC Microservices

Bidirectional streaming with automatic WebSocket bridge - perfect for real-time architectures.

AI-Native Documentation

First Django framework with MCP server - AI assistants can access docs instantly.

8 Enterprise Apps

User auth • Support tickets • Newsletter • CRM • AI agents • Knowledge base • Payments • Multi-site

Time saved: 18+ months of development

→ See All Features

---

What's Included

Backend:

• Django 5.2+ with type-safe config
• PostgreSQL, Redis, Centrifugo
• gRPC server with streaming
• 8 production-ready apps
• AI agent framework
• REST API with auto TypeScript generation

Admin:

• Django Unfold for CRUD
• JWT authentication
• Dark theme by default
• Constance-backed dynamic settings

DevOps:

• Docker Compose setup
• Traefik reverse proxy
• Production-ready configs
• Cloudflare integration

AI Features:

• MCP server for AI assistants
• Pydantic AI integration
• Vector DB (ChromaDB)
• RAG support

---

Documentation

• Getting Started - Quick setup guide
• Configuration - Type-safe config
• API Generation - Typed TS/Python/Go clients
• Real-Time - WebSockets setup
• gRPC - Microservices
• AI Agents - Automation
• Built-in Apps - 8 enterprise apps

---

Community

• djangocfg.com - Official website
• Live Demo - See it in action
• GitHub - Source code
• Discussions - Get help
• PyPI - Package repository

---

License

MIT License - Free for commercial use

---