Why Django-CFG?

# 500+ line settings.py
DEBUG = True  # ❌ Forgot to disable in production
SECRET_KEY = "hardcoded"  # ❌ Secret in repository
DATABASES = {'default': {...}}  # ❌ Manual routing
INSTALLED_APPS = [...]  # ❌ 50+ apps to configure
MIDDLEWARE = [...]  # ❌ Manual security setup
 
# Missing enterprise features:
# ❌ No type safety
# ❌ No user profiles with OTP
# ❌ No background tasks
# ❌ No webhook testing
# ❌ Ugly 2010 admin interface
# ❌ No API documentation
# ❌ No multi-database routing
# ❌ No currency conversion

# config.py - Production-ready in 30 seconds
from django_cfg import DjangoConfig
 
class MyConfig(DjangoConfig):
    project_name: str = "My Enterprise App"
 
    # ✅ Type-safe configuration (Pydantic v2)
    # ✅ Modern admin interface (Unfold + Tailwind)
    # ✅ Real-time dashboard (Live metrics, KPIs)
    # ✅ Multi-database routing (Smart auto-routing)
    # ✅ API documentation (Auto-generated OpenAPI)
 
    # ✅ Built-in features (one line each!)
    enable_accounts: bool = True      # User management + OTP auth
 
    # ✅ Background tasks (ReArq)
    # ✅ Webhook testing (ngrok)
    # ✅ Email and Telegram notifications
    # ✅ Currency conversion (14K+ currencies)
    # ✅ LLM integration (OpenAI/OpenRouter)
 
config = MyConfig()

# ❌ Traditional Django - Runtime disaster
DATABASES = {
    'default': {
        'PORT': '5432',  # String instead of int - crash!
        'NAMEE': 'mydb',  # Typo - silent failure
    }
}

# ✅ Django-CFG - Compile-time validation
class MyConfig(DjangoConfig):
    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(
            engine="postgresql",
            name=env.database.name,  # Type-checked
            port=5432,  # IDE validates type
        )
    }

# Django-CFG MCP module enables AI agent tools for your Django project
from django_cfg import DjangoMCPModuleConfig, MCPConfigBuilder
 
# In your DjangoConfig:
class MyConfig(DjangoConfig):
    mcp: DjangoMCPModuleConfig = DjangoMCPModuleConfig(
        enabled=True,
        builder=MCPConfigBuilder(
            expose_models=True,
            expose_commands=True,
        ),
    )

# ✅ Multi-channel OTP authentication
enable_accounts: bool = True
 
# Automatically provides:
# - Email OTP authentication
# - User profiles and activity tracking
# - Registration source tracking
# - Security audit logs
# - Custom user model (AUTH_USER_MODEL)

unfold: UnfoldConfig = UnfoldConfig(
    site_title="My Admin",
    theme="auto",  # auto/light/dark
)

# Automatic dashboard at /admin/ with built-in endpoints:
# - /cfg/dashboard/api/statistics/ - User & app stats
# - /cfg/dashboard/api/health/ - System health checks
# - /cfg/dashboard/api/charts/ - Chart data
# - /cfg/dashboard/api/commands/ - Django commands
 
# Dashboard automatically displays:
# - Real-time metrics
# - System health
# - Interactive charts
# - Command execution

databases: dict[str, DatabaseConfig] = {
    "default": DatabaseConfig(
        engine="postgresql",
        name="main_db",
    ),
    "analytics": DatabaseConfig(
        name="analytics_db",
        apps=["analytics", "reports"],  # Auto-routes!
    ),
    "cache": DatabaseConfig(
        engine="redis",
        location="${REDIS_URL}",
    )
}
 
# No manual .using() calls needed!
report = Report.objects.create(...)  # Automatically goes to analytics_db

openapi_client: OpenAPIClientConfig = OpenAPIClientConfig(
    enabled=True,
    generate_package_files=True,
    generate_zod_schemas=True,
    generate_fetchers=True,
    generate_swr_hooks=True,
    api_prefix="api",
    output_dir="openapi",
    drf_title="My App API",
    drf_description="Complete API documentation",
    drf_version="1.0.0",
    groups=[
        OpenAPIGroupConfig(
            name="profiles",
            apps=["apps.profiles"],
            title="Profiles API",
            description="User profiles management",
            version="1.0.0",
        ),
        OpenAPIGroupConfig(
            name="trading",
            apps=["apps.trading"],
            title="Trading API",
            description="Trading operations",
            version="1.0.0",
        ),
    ],
)

from django_cfg.apps.tasks import task
 
@task(queue="high", job_retry=3)
async def process_document(document_id: str) -> dict:
    """Process document asynchronously."""
    from asgiref.sync import sync_to_async
    document = await sync_to_async(Document.objects.get)(id=document_id)
    # Your processing logic
    return {"status": "completed"}
 
# Queue task
job = await process_document.delay(document_id="123")
 
# CLI: rearq main:rearq worker --queues high

# config.py
ngrok: NgrokConfig = NgrokConfig(enabled=True)
 
# CLI: python manage.py runserver_ngrok
# ✅ Ngrok tunnel ready: https://abc123.ngrok.io
# ✅ ALLOWED_HOSTS updated automatically
# ✅ Webhook URLs available everywhere

from django_cfg.modules.django_ngrok import get_webhook_url
 
# Get webhook URL automatically
webhook_url = get_webhook_url("/api/webhooks/stripe/")
# "https://abc123.ngrok.io/api/webhooks/stripe/"

from django_cfg.modules.django_currency import convert_currency  # optional module
 
# Convert any currency pair
amount_eur = convert_currency(100, "USD", "EUR")
# Supports: Fiat, Crypto, Stocks, Commodities
 
# Data sources:
# - YFinance (stocks, forex, crypto)
# - CoinGecko (14K+ cryptocurrencies)
# - Multi-threaded parallel fetching

from django_cfg import DjangoEmailService
 
email = DjangoEmailService()
email.send_simple(
    subject="Welcome!",
    body="Hello from Django-CFG",
    recipients=["[email protected]"]
)

from django_cfg import DjangoTelegram
 
telegram = DjangoTelegram()
telegram.send_message(
    chat_id="123456",
    text="System alert!"
)

from django_cfg.modules.django_llm import LLMClient
 
client = LLMClient(provider="openrouter")
response = client.chat_completion([
    {"role": "user", "content": "Translate to Spanish: Hello"}
])