Django-CFG Examples

from django_cfg.modules.django_email import DjangoEmailService
 
email = DjangoEmailService()
email.send_simple(
    subject="Welcome to Django-CFG",
    body="Thank you for signing up!",
    recipients=["[email protected]"]
)

from django_cfg.modules.django_twilio import DjangoTwilioService
 
twilio = DjangoTwilioService()
twilio.send_sms(
    to="+1234567890",
    message="Your verification code: 123456"
)

from django_cfg.modules.django_telegram import DjangoTelegramService
 
telegram = DjangoTelegramService()
telegram.send_message(
    chat_id="123456",
    text="🚀 Your order has been shipped!"
)

from django_cfg import DjangoConfig, DatabaseConfig
 
class MyConfig(DjangoConfig):
    databases: dict[str, DatabaseConfig] = {
        "default": DatabaseConfig(
            engine="postgresql",
            name="main_db",
        ),
        "analytics": DatabaseConfig(
            name="analytics_db",
            routing_apps=["analytics", "reports"],  # Auto-routes!
        ),
    }

# No manual .using() calls needed!
report = Report.objects.create(...)  # Automatically goes to analytics_db
user = User.objects.create(...)      # Goes to default database

# Built-in endpoints automatically available:
# - /cfg/dashboard/api/statistics/ - Real-time statistics
# - /cfg/dashboard/api/health/ - System health monitoring
# - /cfg/dashboard/api/charts/ - Chart data
# - /cfg/dashboard/api/commands/ - Command execution
 
# To customize, extend the service classes:
from django_cfg.apps.dashboard.services import StatisticsService
 
class CustomStatisticsService(StatisticsService):
    def get_custom_metrics(self):
        # Add your custom metrics
        return {"custom_metric": 42}

from django_cfg import OpenAPIClientConfig, OpenAPIGroupConfig
 
class MyConfig(DjangoConfig):
    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="public",
                apps=["blog", "products"],
                title="Public API",
                description="Public-facing API endpoints",
                version="1.0.0",
            ),
            OpenAPIGroupConfig(
                name="partner",
                apps=["integrations"],
                title="Partner API",
                description="Partner integration endpoints",
                version="1.0.0",
            ),
        ],
    )

# config.py
enable_support: bool = True  # Complete ticketing system!
 
# Automatically provides:
# - Ticket management
# - Modern chat interface
# - Email notifications
# - Admin dashboard
# - REST API endpoints

enable_accounts: bool = True  # Advanced user management!
 
# Automatically provides:
# - Email OTP authentication
# - SMS OTP authentication (Twilio)
# - User profiles
# - Activity tracking
# - Security audit logs

enable_newsletter: bool = True  # Email marketing!
 
# Automatically provides:
# - Newsletter campaigns
# - Subscriber management
# - Email tracking (opens, clicks)
# - Analytics dashboard

# config.py
ngrok: NgrokConfig = NgrokConfig(enabled=True)

# Start with ngrok tunnel
python manage.py runserver_ngrok
 
# Output:
# ✅ Ngrok tunnel ready: https://abc123.ngrok.io

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

from django_cfg.apps.accounts.services.otp_service import OTPService
 
# Request OTP
success, error = OTPService.request_email_otp("[email protected]")
 
# Verify OTP
user = OTPService.verify_email_otp("[email protected]", "123456")

# Request SMS OTP
success, error = OTPService.request_phone_otp("+1234567890")
 
# Verify SMS OTP
user = OTPService.verify_phone_otp("+1234567890", "123456")