django-cfg 1.1.81__tar.gz → 1.1.82__tar.gz

{django_cfg-1.1.81 → django_cfg-1.1.82}/MANIFEST.in

@@ -1,3 +1,7 @@
+# Exclude all markdown files except main README.md and CHANGELOG.md
+recursive-exclude * *.md
+include README.md
+include CHANGELOG.md
 include LICENSE
 include MANIFEST.in
 include requirements*.txt
@@ -37,9 +41,4 @@ exclude .gitignore
 # Exclude Node.js files
 exclude package*.json
 exclude yarn*.lock
-recursive-exclude node_modules *
-
-# Exclude all markdown files except main README.md and CHANGELOG.md
-recursive-exclude * *.md
-include README.md
-include CHANGELOG.md
+recursive-exclude node_modules *

{django_cfg-1.1.81 → django_cfg-1.1.82}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-cfg
-Version: 1.1.81
+Version: 1.1.82
 Summary: 🚀 Production-ready Django configuration framework with type-safe settings, smart automation, and modern developer experience
 Project-URL: Homepage, https://github.com/markolofsen/django-cfg
 Project-URL: Documentation, https://django-cfg.readthedocs.io

{django_cfg-1.1.81 → django_cfg-1.1.82}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "django-cfg"
-version = "1.1.81"
+version = "1.1.82"
 description = "🚀 Production-ready Django configuration framework with type-safe settings, smart automation, and modern developer experience"
 readme = "README.md"
 license = {text = "MIT"}
@@ -194,10 +194,7 @@ django-cfg = "django_cfg.cli.main:main"
 packages = ["src/django_cfg"]
 exclude = [
     "django_sample",        # Exclude django_sample directory (use archive instead)
-    "scripts/",             # Exclude scripts from wheel package
-    "**/*.md",              # Exclude all markdown files from wheel
-    "!README.md",           # But include main README.md
-    "!CHANGELOG.md",        # But include CHANGELOG.md
+    "scripts/",  # Exclude scripts from wheel package
 ]
 
 [tool.hatch.metadata]
@@ -218,10 +215,7 @@ exclude = [
     "scripts",             # Exclude development scripts
     "*.log",
     ".env*",
-    "django_sample",       # Exclude django_sample directory (use archive instead)
-    "**/*.md",             # Exclude all markdown files
-    "!README.md",          # But include main README.md
-    "!CHANGELOG.md",       # But include CHANGELOG.md
+    "django_sample",        # Exclude django_sample directory (use archive instead)
 ]
 
 # Black configuration

{django_cfg-1.1.81 → django_cfg-1.1.82}/src/django_cfg/__init__.py

@@ -38,7 +38,7 @@ default_app_config = "django_cfg.apps.DjangoCfgConfig"
 from typing import TYPE_CHECKING
 
 # Version information
-__version__ = "1.1.81"
+__version__ = "1.1.82"
 __author__ = "Unrealos Team"
 __email__ = "info@unrealos.com"
 __license__ = "MIT"

django_cfg-1.1.82/src/django_cfg/modules/django_twilio/templates/guide.md

@@ -0,0 +1,266 @@
+# 🚀 Django CFG Twilio Integration - Complete Setup Guide
+
+## 📋 Overview
+
+Django CFG Twilio provides seamless integration for:
+- 📱 **WhatsApp OTP** via Twilio Verify API
+- 📱 **SMS OTP** via Twilio Verify API  
+- 📧 **Email OTP** via SendGrid
+- 🔧 **Testing Suite** with management commands
+- 📧 **HTML Email Templates** with customization
+
+## 🛠️ Quick Setup (5 minutes)
+
+### 1. Install Dependencies
+```bash
+pip install django-cfg[twilio]
+# or
+poetry add django-cfg[twilio]
+```
+
+### 2. Configure Twilio Services
+
+#### A. Create Twilio Verify Service
+1. Go to [Twilio Console > Verify > Services](https://console.twilio.com/us1/develop/verify/services)
+2. Click **Create new Service**
+3. Name: `YourApp OTP Service`
+4. **Enable channels**: WhatsApp ✅, SMS ✅
+5. Copy the **Service SID** (starts with `VA...`)
+
+#### B. Get SendGrid API Key (Optional)
+1. Go to [SendGrid Console > API Keys](https://app.sendgrid.com/settings/api_keys)
+2. Create new API key with **Mail Send** permissions
+3. Copy the API key (starts with `SG.`)
+
+### 3. Update Configuration Files
+
+#### `config.dev.yaml`
+```yaml
+twilio:
+  account_sid: "AC_YOUR_ACCOUNT_SID"
+  auth_token: "YOUR_AUTH_TOKEN"
+  whatsapp_from: "+14155238886"  # Twilio sandbox
+  sms_from: "+YOUR_SMS_NUMBER"
+  sendgrid_api_key: "SG.YOUR_SENDGRID_API_KEY"
+  verify_service_sid: "VA_YOUR_VERIFY_SERVICE_SID"
+```
+
+#### `config.py`
+```python
+from django_cfg.modules.django_twilio.models import SendGridConfig, TwilioVerifyConfig, TwilioChannelType
+
+class YourProjectConfig(DjangoConfig):
+    # Admin emails for testing
+    admin_emails: List[str] = ["admin@yourdomain.com"]
+    
+    # Twilio configuration
+    twilio: Optional[TwilioConfig] = TwilioConfig(
+        account_sid=env.twilio.account_sid,
+        auth_token=SecretStr(env.twilio.auth_token),
+        
+        # Verify API for OTP
+        verify=TwilioVerifyConfig(
+            service_sid=env.twilio.verify_service_sid,
+            service_name=env.app.name,
+            default_channel=TwilioChannelType.WHATSAPP,
+            fallback_channels=[TwilioChannelType.SMS],
+            code_length=6,
+            ttl_seconds=600,  # 10 minutes
+            max_attempts=5,
+        ) if env.twilio.verify_service_sid else None,
+        
+        # SendGrid for email
+        sendgrid=SendGridConfig(
+            api_key=SecretStr(env.twilio.sendgrid_api_key),
+            from_email="noreply@yourdomain.com",
+            from_name=env.app.name,
+            default_subject=f"Your {env.app.name} verification code",
+        ) if env.twilio.sendgrid_api_key else None,
+    ) if env.twilio.account_sid and env.twilio.auth_token else None
+```
+
+## 🧪 Testing Everything
+
+### Quick Test Command
+```bash
+# Test all services
+python manage.py test_twilio --mode=all
+
+# Test OTP only
+python manage.py test_twilio --mode=test-otp --phone="+1234567890"
+
+# Interactive mode
+python manage.py test_twilio --interactive
+
+# Check configuration
+python manage.py test_twilio --mode=setup
+```
+
+### Expected Output
+```
+🚀 Django CFG Twilio Test Suite
+==================================================
+📧 Using admin email from config: admin@yourdomain.com
+
+🔧 Configuration Check
+------------------------------
+✅ Admin emails configured
+✅ Twilio configuration found
+✅ Verify API configured
+✅ SendGrid configured
+✅ Email configuration found
+
+🔐 Testing OTP Functionality
+------------------------------
+📱 Testing WhatsApp OTP to +1234567890...
+✅ OTP sent via WhatsApp to ***7890
+
+📧 Testing Email OTP to admin@yourdomain.com...
+✅ Email OTP sent (code: 123456)
+
+🎉 All tests completed!
+```
+
+## 🔌 API Usage
+
+### Basic OTP Request
+```python
+from django_cfg.modules.django_twilio import send_whatsapp_otp, verify_otp
+
+# Send WhatsApp OTP
+success, message = send_whatsapp_otp("+1234567890")
+
+# Verify OTP
+is_valid, message = verify_otp("+1234567890", "123456")
+```
+
+### Email OTP
+```python
+from django_cfg.modules.django_twilio import send_otp_email
+
+# Send email OTP
+success, message, otp_code = send_otp_email("user@example.com")
+```
+
+### REST API Endpoints
+```bash
+# Request OTP
+curl -X POST http://localhost:8000/api/accounts/otp/request/ \
+  -H "Content-Type: application/json" \
+  -d '{"identifier": "+1234567890", "channel": "phone"}'
+
+# Verify OTP
+curl -X POST http://localhost:8000/api/accounts/otp/verify/ \
+  -H "Content-Type: application/json" \
+  -d '{"identifier": "+1234567890", "otp": "123456", "channel": "phone"}'
+```
+
+## 📧 Email Templates
+
+### Template Structure
+```
+django_cfg/modules/django_twilio/templates/
+├── email_otp_template.html      # Main HTML template
+├── email_otp_test_data.json     # Test data
+└── email_otp_rendered.html      # Generated preview
+```
+
+### Template Variables
+- `{{app_name}}` - Your app name
+- `{{user_name}}` - User's name
+- `{{otp_code}}` - 6-digit OTP code
+- `{{otp_link}}` - Verification link
+- `{{expires_minutes}}` - Expiry time
+
+### Generate Templates
+```bash
+python manage.py test_twilio --mode=generate-templates
+```
+
+## 🚨 Troubleshooting
+
+### Common Issues
+
+#### 1. WhatsApp Not Working
+```
+❌ Error: Unable to create record: Delivery channel disabled: WHATSAPP
+```
+**Solution**: Enable WhatsApp channel in [Twilio Console > Verify > Services](https://console.twilio.com/us1/develop/verify/services)
+
+#### 2. SMS to International Numbers
+```
+❌ Error: Message cannot be sent with current 'To' and 'From' parameters
+```
+**Solution**: Use Verify API (automatic) or upgrade Twilio account for international SMS
+
+#### 3. SendGrid Not Working
+```
+❌ Error: SendGrid configuration not found
+```
+**Solution**: Add `sendgrid_api_key` to your YAML config and enable in `config.py`
+
+#### 4. Email Not Sending
+```
+❌ Error: Email backend not configured
+```
+**Solution**: Check email configuration in `config.py` and ensure SMTP settings are correct
+
+### Debug Mode
+```python
+# Enable detailed logging
+twilio: TwilioConfig = TwilioConfig(
+    debug_logging=True,  # Shows all API requests/responses
+    test_mode=True,      # Uses test credentials
+)
+```
+
+## 📱 Production Checklist
+
+### Before Going Live:
+
+#### Twilio Setup
+- [ ] **Account verified** and upgraded from trial
+- [ ] **Phone numbers verified** for SMS
+- [ ] **WhatsApp Business approved** (if using production WhatsApp)
+- [ ] **Verify Service** created and channels enabled
+- [ ] **Webhook URLs** configured (optional)
+
+#### SendGrid Setup  
+- [ ] **Domain authentication** completed
+- [ ] **Sender identity** verified
+- [ ] **API key** with proper permissions
+- [ ] **Email templates** tested and approved
+
+#### Security
+- [ ] **Environment variables** for sensitive data
+- [ ] **Rate limiting** configured
+- [ ] **Admin emails** updated for production
+- [ ] **Error monitoring** setup (Sentry, etc.)
+
+#### Testing
+- [ ] **All OTP channels** tested with real numbers
+- [ ] **Email delivery** tested with real addresses  
+- [ ] **Error handling** tested with invalid inputs
+- [ ] **Load testing** completed for expected volume
+
+## 🔗 Useful Links
+
+- [Twilio Console](https://console.twilio.com/)
+- [Twilio Verify API Docs](https://www.twilio.com/docs/verify/api)
+- [SendGrid Console](https://app.sendgrid.com/)
+- [Django CFG Documentation](https://github.com/your-repo/django-cfg)
+
+## 💡 Pro Tips
+
+1. **Use Verify API** for professional OTP instead of custom solutions
+2. **Enable both WhatsApp and SMS** for better delivery rates
+3. **Test with real numbers** in different countries
+4. **Monitor delivery rates** in Twilio Console
+5. **Use admin_emails** for easy testing configuration
+6. **Keep templates simple** for better email client compatibility
+
+---
+
+🎉 **You're all set!** Your Django CFG Twilio integration is ready for production use.
+
+For support, check the troubleshooting section or create an issue on GitHub.

django_cfg-1.1.81/@docs/dramatiq/README.md

@@ -1,153 +0,0 @@
-# 🎭 Dramatiq Integration for Django-CFG
-
-## 📚 Documentation Index
-
-This directory contains comprehensive documentation for Dramatiq integration in Django-CFG.
-
-### 📖 Available Documents
-
-| Document | Description | Target Audience |
-|----------|-------------|-----------------|
-| **[DRAMATIQ_INTEGRATION.md](./DRAMATIQ_INTEGRATION.md)** | Complete technical documentation following @DOCS_MODULE.md methodology | Developers, Architects |
-| **[IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md)** | Detailed 6-week implementation roadmap | Project Managers, Developers |
-| **[EXAMPLES.md](./EXAMPLES.md)** | Real-world usage examples and patterns | Developers, DevOps |
-
-## 🎯 Quick Navigation
-
-### For Developers
-- **Getting Started** → [DRAMATIQ_INTEGRATION.md#usage-examples](./DRAMATIQ_INTEGRATION.md#-usage-examples)
-- **Configuration** → [DRAMATIQ_INTEGRATION.md#data-models](./DRAMATIQ_INTEGRATION.md#-data-models-pydantic-2--typescript)
-- **Task Patterns** → [EXAMPLES.md#task-definition-examples](./EXAMPLES.md#-task-definition-examples)
-- **Error Handling** → [EXAMPLES.md#error-handling-examples](./EXAMPLES.md#-error-handling-examples)
-
-### For Project Managers
-- **Implementation Timeline** → [IMPLEMENTATION_PLAN.md#timeline](./IMPLEMENTATION_PLAN.md#-timeline)
-- **Resource Requirements** → [IMPLEMENTATION_PLAN.md#technical-implementation-details](./IMPLEMENTATION_PLAN.md#-technical-implementation-details)
-- **Risk Assessment** → [IMPLEMENTATION_PLAN.md#risk-mitigation](./IMPLEMENTATION_PLAN.md#-risk-mitigation)
-
-### For DevOps Engineers
-- **Production Setup** → [EXAMPLES.md#management-commands-usage](./EXAMPLES.md#-management-commands-usage)
-- **Monitoring** → [EXAMPLES.md#monitoring-and-observability](./EXAMPLES.md#-monitoring-and-observability)
-- **Deployment** → [DRAMATIQ_INTEGRATION.md#production-considerations](./DRAMATIQ_INTEGRATION.md#priority-high-production-considerations)
-
-## 🚀 Key Features
-
-### ✅ What's Included
-- **Zero Configuration** - Works out of the box with Redis
-- **Type Safety** - Full Pydantic v2 validation
-- **Production Ready** - Comprehensive middleware stack
-- **Redis Reuse** - Leverages existing cache configuration
-- **Optional Dependency** - Install only when needed
-
-### 🎯 Use Cases
-- **Background Tasks** - Email sending, report generation
-- **Async Processing** - File uploads, data processing
-- **Scheduled Jobs** - Cleanup tasks, periodic reports
-- **High Reliability** - Payment processing, critical operations
-
-## 📋 Implementation Status
-
-| Component | Status | Documentation |
-|-----------|--------|---------------|
-| **Core Models** | 📝 Designed | [DRAMATIQ_INTEGRATION.md](./DRAMATIQ_INTEGRATION.md) |
-| **Service Layer** | 📝 Designed | [DRAMATIQ_INTEGRATION.md](./DRAMATIQ_INTEGRATION.md) |
-| **Django Integration** | 📝 Designed | [IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md) |
-| **Management Commands** | 📝 Designed | [EXAMPLES.md](./EXAMPLES.md) |
-| **Testing Strategy** | 📝 Planned | [IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md) |
-| **Production Examples** | ✅ Complete | [EXAMPLES.md](./EXAMPLES.md) |
-
-## 🔧 Quick Start
-
-### 1. Installation
-```bash
-# Install Django-CFG with task support
-pip install django-cfg[tasks]
-```
-
-### 2. Configuration
-```python
-# config.py
-from django_cfg import DjangoConfig
-from django_cfg.models.tasks import TaskConfig
-
-class MyConfig(DjangoConfig):
-    project_name: str = "MyApp"
-    
-    # Redis for cache + tasks
-    cache_default: CacheBackend = CacheBackend(redis_url="redis://localhost:6379/0")
-    
-    # Enable tasks with zero configuration
-    tasks: TaskConfig = TaskConfig()
-
-config = MyConfig()
-```
-
-### 3. Define Tasks
-```python
-# tasks.py
-import dramatiq
-
-@dramatiq.actor
-def send_email(user_id: int):
-    # Task implementation
-    pass
-```
-
-### 4. Use Tasks
-```python
-# views.py
-send_email.send(user.id)  # Queue task
-```
-
-### 5. Run Workers
-```bash
-python manage.py rundramatiq
-```
-
-## 📊 Architecture Overview
-
-```
-┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
-│   Django-CFG    │    │     Redis       │    │   Dramatiq      │
-│   TaskConfig    │───▶│   Message       │◀───│   Workers       │
-│                 │    │   Broker        │    │                 │
-└─────────────────┘    └─────────────────┘    └─────────────────┘
-         │                       │                       │
-         ▼                       ▼                       ▼
-┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
-│   Pydantic      │    │   Queue         │    │   Task          │
-│   Validation    │    │   Management    │    │   Execution     │
-└─────────────────┘    └─────────────────┘    └─────────────────┘
-```
-
-## 🤝 Contributing
-
-### Documentation Standards
-- Follow [@DOCS_MODULE.md](../@docs.ai/DOCS_MODULE.md) methodology
-- Keep files under 1000 lines
-- Include working code examples
-- Use AI-friendly markers (%%PRIORITY:HIGH%%, etc.)
-
-### Code Standards
-- Type hints for all functions
-- Pydantic v2 for configuration
-- Comprehensive error handling
-- Production-ready defaults
-
-## 📞 Support
-
-### Issues and Questions
-- **Technical Issues** → Create GitHub issue with `dramatiq` label
-- **Configuration Help** → Check [EXAMPLES.md](./EXAMPLES.md)
-- **Performance Issues** → See [Production Considerations](./DRAMATIQ_INTEGRATION.md#priority-high-production-considerations)
-
-### Community Resources
-- **Django-CFG Discussions** → GitHub Discussions
-- **Dramatiq Documentation** → https://dramatiq.io/
-- **Redis Documentation** → https://redis.io/documentation
-
----
-
-**Made with ❤️ by the Django-CFG Team**
-
-*Dramatiq Integration: Because background tasks should be simple, safe, and powerful.*