django-cfg 1.2.10__tar.gz → 1.2.12__tar.gz

django_cfg-1.2.12/PKG-INFO

@@ -0,0 +1,574 @@
+Metadata-Version: 2.4
+Name: django-cfg
+Version: 1.2.12
+Summary: 🚀 Next-gen Django configuration: type-safety, AI features, blazing-fast setup, and automated best practices — all in one.
+Project-URL: Homepage, https://djangocfg.com
+Project-URL: Documentation, https://docs.djangocfg.com
+Project-URL: Repository, https://github.com/reformsai/django-cfg
+Project-URL: Issues, https://github.com/reformsai/django-cfg/issues
+Project-URL: Changelog, https://github.com/reformsai/django-cfg/blob/main/CHANGELOG.md
+Author-email: Django-CFG Team <info@djangocfg.com>
+Maintainer-email: Django-CFG Team <info@djangocfg.com>
+License: MIT
+License-File: LICENSE
+Keywords: configuration,developer-experience,django,pydantic,settings,type-safety
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.12
+Requires-Dist: beautifulsoup4<5.0,>=4.13.0
+Requires-Dist: cachetools<7.0,>=5.3.0
+Requires-Dist: click<9.0,>=8.2.0
+Requires-Dist: colorlog<7.0,>=6.9.0
+Requires-Dist: coolname<3.0,>=2.2.0
+Requires-Dist: currencyconverter<1.0,>=0.18.0
+Requires-Dist: dj-database-url<4.0,>=3.0.0
+Requires-Dist: django-admin-rangefilter<1.0,>=0.13.0
+Requires-Dist: django-constance<5.0,>=4.3.0
+Requires-Dist: django-cors-headers<5.0,>=4.7.0
+Requires-Dist: django-dramatiq<1.0,>=0.14.0
+Requires-Dist: django-extensions<5.0,>=4.1.0
+Requires-Dist: django-filter<26.0,>=25.0
+Requires-Dist: django-import-export<5.0,>=4.3.0
+Requires-Dist: django-json-widget<3.0,>=2.0.0
+Requires-Dist: django-ratelimit<5.0.0,>=4.1.0
+Requires-Dist: django-redis<7.0,>=6.0.0
+Requires-Dist: django-revolution<2.0,>=1.0.43
+Requires-Dist: django-unfold<1.0,>=0.64.0
+Requires-Dist: djangorestframework-simplejwt<6.0,>=5.5.0
+Requires-Dist: djangorestframework-simplejwt[token-blacklist]<6.0,>=5.5.0
+Requires-Dist: djangorestframework<4.0,>=3.16.0
+Requires-Dist: dramatiq[redis]<2.0,>=1.18.0
+Requires-Dist: drf-nested-routers<1.0,>=0.94.0
+Requires-Dist: drf-spectacular-sidecar<2026.0,>=2025.8.0
+Requires-Dist: drf-spectacular<1.0,>=0.28.0
+Requires-Dist: hiredis<4.0,>=2.0.0
+Requires-Dist: loguru<1.0,>=0.7.0
+Requires-Dist: lxml<7.0,>=6.0.0
+Requires-Dist: ngrok>=1.5.1; python_version >= '3.12'
+Requires-Dist: openai<2.0,>=1.107.0
+Requires-Dist: pgvector<1.0,>=0.4.0
+Requires-Dist: psycopg[binary,pool]<4.0,>=3.2.0
+Requires-Dist: pydantic-ai<2.0,>=1.0.10
+Requires-Dist: pydantic-yaml<2.0,>=1.6.0
+Requires-Dist: pydantic<3.0,>=2.11.0
+Requires-Dist: pydantic[email]<3.0,>=2.11.0
+Requires-Dist: pytelegrambotapi<5.0,>=4.28.0
+Requires-Dist: python-json-logger<4.0,>=3.3.0
+Requires-Dist: pyyaml<7.0,>=6.0
+Requires-Dist: questionary<3.0,>=2.1.0
+Requires-Dist: redis<7.0,>=6.4.0
+Requires-Dist: requests<3.0,>=2.32.0
+Requires-Dist: rich<15.0,>=14.0.0
+Requires-Dist: sendgrid<7.0,>=6.12.0
+Requires-Dist: tiktoken<1.0,>=0.11.0
+Requires-Dist: toml<0.11.0,>=0.10.2
+Requires-Dist: twilio<10.0,>=9.8.0
+Requires-Dist: whitenoise<7.0,>=6.8.0
+Provides-Extra: dev
+Requires-Dist: black<26.0,>=25.9; extra == 'dev'
+Requires-Dist: build<2.0,>=1.3; extra == 'dev'
+Requires-Dist: django<6.0,>=5.2; extra == 'dev'
+Requires-Dist: factory-boy<4.0,>=3.3; extra == 'dev'
+Requires-Dist: flake8<8.0,>=6.0.0; extra == 'dev'
+Requires-Dist: isort<7.0,>=6.0; extra == 'dev'
+Requires-Dist: mkdocs-material<10.0,>=9.6; extra == 'dev'
+Requires-Dist: mkdocs<2.0,>=1.6; extra == 'dev'
+Requires-Dist: mkdocstrings[python]<1.0,>=0.30; extra == 'dev'
+Requires-Dist: mypy<2.0,>=1.18; extra == 'dev'
+Requires-Dist: pre-commit<5.0,>=4.3; extra == 'dev'
+Requires-Dist: pytest-cov<8.0,>=7.0; extra == 'dev'
+Requires-Dist: pytest-django<5.0,>=4.11; extra == 'dev'
+Requires-Dist: pytest-mock<4.0,>=3.15; extra == 'dev'
+Requires-Dist: pytest<9.0,>=8.4; extra == 'dev'
+Requires-Dist: questionary<3.0,>=2.1.0; extra == 'dev'
+Requires-Dist: redis<7.0,>=6.4.0; extra == 'dev'
+Requires-Dist: rich<15.0,>=13.0.0; extra == 'dev'
+Requires-Dist: tomlkit<1.0,>=0.13.3; extra == 'dev'
+Requires-Dist: twine<7.0,>=6.2; extra == 'dev'
+Provides-Extra: django52
+Requires-Dist: django<6.0,>=5.2; extra == 'django52'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material<10.0,>=9.6; extra == 'docs'
+Requires-Dist: mkdocs<2.0,>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]<1.0,>=0.30; extra == 'docs'
+Requires-Dist: pymdown-extensions<11.0,>=10.16; extra == 'docs'
+Provides-Extra: full
+Requires-Dist: black<26.0,>=25.9; extra == 'full'
+Requires-Dist: build<2.0,>=1.3; extra == 'full'
+Requires-Dist: django<6.0,>=5.2; extra == 'full'
+Requires-Dist: factory-boy<4.0,>=3.3; extra == 'full'
+Requires-Dist: flake8<8.0,>=6.0.0; extra == 'full'
+Requires-Dist: isort<7.0,>=6.0; extra == 'full'
+Requires-Dist: mkdocs-material<10.0,>=9.6; extra == 'full'
+Requires-Dist: mkdocs<2.0,>=1.6; extra == 'full'
+Requires-Dist: mkdocstrings[python]<1.0,>=0.30; extra == 'full'
+Requires-Dist: mypy<2.0,>=1.18; extra == 'full'
+Requires-Dist: pre-commit<5.0,>=4.3; extra == 'full'
+Requires-Dist: pymdown-extensions<11.0,>=10.16; extra == 'full'
+Requires-Dist: pytest-cov<8.0,>=7.0; extra == 'full'
+Requires-Dist: pytest-django<5.0,>=4.11; extra == 'full'
+Requires-Dist: pytest-mock<4.0,>=3.15; extra == 'full'
+Requires-Dist: pytest-xdist<4.0,>=3.8; extra == 'full'
+Requires-Dist: pytest<9.0,>=8.4; extra == 'full'
+Requires-Dist: questionary<3.0,>=2.1.0; extra == 'full'
+Requires-Dist: redis<7.0,>=6.4.0; extra == 'full'
+Requires-Dist: rich<15.0,>=13.0.0; extra == 'full'
+Requires-Dist: tomlkit<1.0,>=0.13.3; extra == 'full'
+Requires-Dist: twine<7.0,>=6.2; extra == 'full'
+Provides-Extra: local
+Provides-Extra: tasks
+Requires-Dist: redis<7.0,>=6.4.0; extra == 'tasks'
+Provides-Extra: test
+Requires-Dist: django<6.0,>=5.2; extra == 'test'
+Requires-Dist: factory-boy<4.0,>=3.3; extra == 'test'
+Requires-Dist: pytest-cov<8.0,>=7.0; extra == 'test'
+Requires-Dist: pytest-django<5.0,>=4.11; extra == 'test'
+Requires-Dist: pytest-mock<4.0,>=3.15; extra == 'test'
+Requires-Dist: pytest-xdist<4.0,>=3.8; extra == 'test'
+Requires-Dist: pytest<9.0,>=8.4; extra == 'test'
+Description-Content-Type: text/markdown
+
+# 🚀 Django-CFG: Type-Safe Django Configuration
+
+[![Python Version](https://img.shields.io/pypi/pyversions/django-cfg.svg)](https://pypi.org/project/django-cfg/)
+[![Django Version](https://img.shields.io/pypi/djversions/django-cfg.svg)](https://pypi.org/project/django-cfg/)
+[![License](https://img.shields.io/pypi/l/django-cfg.svg)](https://github.com/reformsai/django-cfg/blob/main/LICENSE)
+[![PyPI Version](https://img.shields.io/pypi/v/django-cfg.svg)](https://pypi.org/project/django-cfg/)
+
+> **Create a production-ready Django project in 30 seconds, not 30 hours.**
+
+Production-ready Django configuration with **Pydantic v2 models**, **AI agents**, and **enterprise integrations**. Build modern Django applications with full type safety, intelligent environment detection, and seamless deployment.
+
+🌐 **Website**: [djangocfg.com](https://djangocfg.com/)  
+📚 **Documentation**: [docs.djangocfg.com](https://docs.djangocfg.com/)  
+🐙 **GitHub**: [github.com/reformsai/django-cfg](https://github.com/reformsai/django-cfg)
+
+## 🎯 Quick Start
+
+### Requirements
+- **Python 3.12+** - [Download here](https://www.python.org/downloads/)
+
+### Create Your First Project
+
+```bash
+# Install Django-CFG
+pip install django-cfg
+
+# Create a complete project instantly
+django-cfg create-project "My Awesome Project"
+
+# Enter the project and run
+cd my-awesome-project
+python manage.py runserver
+```
+
+**🎉 That's it!** Your app is now running with:
+- **🚀 Main app:** http://127.0.0.1:8000/
+- **🎯 Admin panel:** http://127.0.0.1:8000/admin/
+- **📚 API docs:** http://127.0.0.1:8000/api/docs/
+
+## ✨ What You Get Out of the Box
+
+✅ **Beautiful admin interface** with Unfold + Tailwind CSS  
+✅ **Complete API documentation** with Swagger/ReDoc  
+✅ **Multi-channel user management** with email & SMS OTP authentication  
+✅ **SMS & WhatsApp integration** with Twilio out of the box  
+✅ **Support ticket system** with chat interface  
+✅ **Newsletter campaigns** with email tracking  
+✅ **Lead management** system with CRM integration  
+✅ **Multi-database routing** and connection pooling  
+✅ **Background task processing** with production-ready Dramatiq integration  
+✅ **Webhook testing** with built-in ngrok integration  
+✅ **Type-safe configuration** with full IDE support
+
+## 🏆 Django-CFG vs Traditional Django
+
+| Feature | Traditional Django | Django-CFG |
+|---------|-------------------|-------------|
+| **📝 Configuration** | 500+ lines of settings hell | **Type-safe & organized** |
+| **🔒 Type Safety** | Pray and hope | **100% validated** |
+| **🎨 Admin Interface** | Ugly 2010 design | **Modern Unfold + Tailwind** |
+| **📊 Dashboard** | Basic admin index | **Real-time metrics & widgets** |
+| **🗄️ Multi-Database** | Manual routing nightmare | **Smart auto-routing** |
+| **📚 API Docs** | Hours of manual setup | **Auto-generated OpenAPI** |
+| **🎫 Support System** | Build from scratch | **Built-in tickets & chat** |
+| **👤 User Management** | Basic User model | **OTP auth & profiles** |
+| **🚀 Deployment** | Cross fingers | **Production-ready defaults** |
+| **💡 IDE Support** | Basic syntax highlighting | **Full IntelliSense paradise** |
+| **🐛 Config Errors** | Runtime surprises | **Compile-time validation** |
+
+## 🔥 Core Features
+
+### 🔒 Type-Safe Configuration
+Full Pydantic v2 validation with IDE autocomplete and compile-time error checking.
+
+```python
+from django_cfg import DjangoConfig
+from django_cfg.models import DatabaseConfig
+
+class MyConfig(DjangoConfig):
+    project_name: str = "My App"
+    secret_key: str = "${SECRET_KEY}"
+    debug: bool = False
+    
+    databases: dict[str, DatabaseConfig] = {
+        "default": DatabaseConfig(
+            engine="django.db.backends.postgresql",
+            name="${DB_NAME}",
+            user="${DB_USER}",
+            password="${DB_PASSWORD}",
+        )
+    }
+
+config = MyConfig()
+```
+
+### 🤖 Built-in AI Agents
+Enterprise-grade AI agent system with type-safe agents and workflow orchestration.
+
+```python
+from django_cfg.agents import Agent, Workflow
+
+@Agent.register("data_processor")
+class DataProcessor(Agent):
+    def process(self, data: dict) -> dict:
+        # Your AI logic here
+        return processed_data
+
+# Use in workflows
+workflow = Workflow([DataProcessor()])
+result = workflow.run(input_data)
+```
+
+### 🌍 Smart Environment Detection
+Automatic dev/staging/production detection with appropriate defaults.
+
+```python
+class MyConfig(DjangoConfig):
+    # Automatically detects environment and applies settings
+    # No manual configuration needed!
+    pass
+```
+
+### 🗄️ Multi-Database Support
+Smart database routing with connection pooling.
+
+```python
+databases: dict[str, DatabaseConfig] = {
+    "default": DatabaseConfig.from_url("postgresql://..."),
+    "analytics": DatabaseConfig.from_url(
+        "postgresql://...",
+        apps=["analytics"],  # Route analytics app here
+    ),
+}
+```
+
+### 🔄 Background Task Processing
+Built-in Dramatiq integration for reliable background jobs.
+
+```python
+import dramatiq
+
+@dramatiq.actor
+def process_document(document_id: str):
+    # Your background task
+    pass
+
+# Queue the task
+process_document.send(document_id="123")
+```
+
+## 📦 Installation Methods
+
+### Using pip (Recommended)
+```bash
+pip install django-cfg
+```
+
+### Using Poetry
+```bash
+poetry add django-cfg
+```
+
+### Using pipenv
+```bash
+pipenv install django-cfg
+```
+
+### Using conda
+```bash
+conda install -c conda-forge django-cfg
+```
+
+## 🚀 Advanced Usage
+
+### Production Configuration
+
+```python
+from django_cfg import DjangoConfig
+from django_cfg.models import *
+
+class ProductionConfig(DjangoConfig):
+    project_name: str = "My Production App"
+    
+    # Multi-database setup
+    databases: dict[str, DatabaseConfig] = {
+        "default": DatabaseConfig(
+            engine="django.db.backends.postgresql",
+            name="${DB_NAME}",
+            host="${DB_HOST}",
+            sslmode="require",
+        ),
+        "analytics": DatabaseConfig(
+            routing_apps=["analytics", "reports"],
+        ),
+    }
+    
+    # Background tasks
+    tasks: TaskConfig = TaskConfig(
+        dramatiq=DramatiqConfig(
+            processes=4,
+            threads=8,
+            queues=["default", "high", "low"],
+        ),
+    )
+    
+    # Beautiful admin
+    unfold: UnfoldConfig = UnfoldConfig(
+        site_title="My Admin",
+        theme="auto",
+        dashboard_callback="myapp.dashboard.callback",
+    )
+```
+
+### Built-in Features
+
+```python
+class MyConfig(DjangoConfig):
+    # Enable built-in modules
+    enable_support: bool = True      # Support ticket system
+    enable_accounts: bool = True     # Advanced user management
+    enable_newsletter: bool = True   # Email marketing
+    enable_leads: bool = True        # Lead management
+    enable_knowbase: bool = True     # AI knowledge base
+    enable_agents: bool = True       # AI agents
+```
+
+## 🛠️ Management Commands
+
+Django-CFG includes powerful CLI tools:
+
+```bash
+# Create new project
+django-cfg create-project "My Project"
+
+# Get system information
+django-cfg info
+
+# Enhanced Django commands
+python manage.py migrator --auto          # Smart migrations
+python manage.py validate_config         # Validate settings
+python manage.py show_config             # Display config
+python manage.py rundramatiq             # Background workers
+python manage.py runserver_ngrok         # Dev server with ngrok
+python manage.py test_email              # Test email config
+python manage.py test_twilio             # Test SMS/WhatsApp
+```
+
+## 🌐 Real-World Example
+
+See how **CarAPIS** (automotive data platform) uses Django-CFG in production:
+
+- **Multi-database architecture** for vehicle data
+- **Background task processing** for tax calculations
+- **SMS/WhatsApp OTP** authentication
+- **API zones** for different services
+- **Custom admin dashboard** with real-time metrics
+
+[View Full CarAPIS Example →](https://docs.djangocfg.com/examples/production-config)
+
+## 📚 Documentation
+
+### Getting Started
+- [**Installation Guide**](https://docs.djangocfg.com/getting-started/installation) - Complete setup instructions
+- [**First Project**](https://docs.djangocfg.com/getting-started/first-project) - Build your first app
+- [**Configuration**](https://docs.djangocfg.com/getting-started/configuration) - Core concepts
+
+### Core Features
+- [**Architecture**](https://docs.djangocfg.com/core/architecture) - System overview
+- [**Environment Detection**](https://docs.djangocfg.com/core/environment-detection) - Automatic environment setup
+- [**Registry System**](https://docs.djangocfg.com/core/registry) - Component registration
+- [**Utilities**](https://docs.djangocfg.com/core/utilities) - Helper functions
+
+### AI & Agents
+- [**AI Agents**](https://docs.djangocfg.com/agents/introduction) - Build intelligent workflows
+- [**Knowledge Base**](https://docs.djangocfg.com/knowbase/setup) - AI-powered documentation
+
+### Integrations
+- [**Integration Patterns**](https://docs.djangocfg.com/integrations/patterns) - Common patterns
+- [**Dramatiq**](https://docs.djangocfg.com/integrations/dramatiq) - Background tasks
+- [**Twilio**](https://docs.djangocfg.com/integrations/twilio) - SMS/WhatsApp
+- [**Authentication**](https://docs.djangocfg.com/integrations/auth) - OTP auth
+
+### Built-in Apps
+- [**Accounts**](https://docs.djangocfg.com/apps/accounts) - User management
+- [**Support System**](https://docs.djangocfg.com/apps/support) - Ticket system
+- [**Newsletter**](https://docs.djangocfg.com/apps/newsletter) - Email marketing
+
+### CLI Tools
+- [**CLI Introduction**](https://docs.djangocfg.com/cli/introduction) - Command overview
+- [**Commands Reference**](https://docs.djangocfg.com/cli/commands) - All commands
+- [**Custom Commands**](https://docs.djangocfg.com/cli/custom-commands) - Build your own
+
+### Examples & Deployment
+- [**Basic Setup**](https://docs.djangocfg.com/examples/basic-setup) - Simple examples
+- [**Production Config**](https://docs.djangocfg.com/examples/production-config) - Real-world setup
+- [**Migration Guide**](https://docs.djangocfg.com/examples/migration-guide) - Migrate existing projects
+- [**Docker Deployment**](https://docs.djangocfg.com/deployment/docker) - Container deployment
+
+## 🔄 Migration from Existing Django
+
+### Option 1: Fresh Start (Recommended)
+```bash
+# Create new Django-CFG project
+django-cfg create-project "My Migrated Project"
+
+# Copy your apps and migrate data
+# See migration guide for details
+```
+
+### Option 2: Gradual Migration
+```bash
+# Install in existing project
+pip install django-cfg
+
+# Create config.py
+# Replace settings.py content
+# Migrate features gradually
+```
+
+[**Complete Migration Guide →**](https://docs.djangocfg.com/examples/migration-guide)
+
+## ⚠️ Troubleshooting
+
+### Python Version Error
+```bash
+# Install Python 3.12+
+brew install python@3.12  # macOS
+# OR
+pyenv install 3.12.0      # Using pyenv
+```
+
+### Virtual Environment Issues
+```bash
+# Create virtual environment
+python3.12 -m venv .venv
+source .venv/bin/activate  # Linux/macOS
+# OR
+.venv\Scripts\activate     # Windows
+```
+
+### Configuration Errors
+```bash
+# Validate your configuration
+python manage.py validate_config --strict
+
+# Show current configuration
+python manage.py show_config
+```
+
+[**Full Troubleshooting Guide →**](https://docs.djangocfg.com/getting-started/installation#troubleshooting)
+
+## 🧪 Testing
+
+```python
+def test_configuration():
+    """Test your Django-CFG configuration"""
+    from config import config
+    
+    # Validate configuration
+    settings = config.get_all_settings()
+    assert "SECRET_KEY" in settings
+    assert settings["DEBUG"] is False
+    
+    # Test database connections
+    assert "default" in settings["DATABASES"]
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Here's how to get started:
+
+```bash
+git clone https://github.com/reformsai/django-cfg.git
+cd django-cfg
+pip install -e ".[dev,test]"
+pytest
+```
+
+### Development Commands
+```bash
+# Run tests
+pytest
+
+# Format code
+black .
+
+# Type checking
+mypy .
+
+# Build package
+python -m build
+```
+
+## 📊 Performance
+
+Django-CFG is designed for production:
+
+- **Startup Time**: < 50ms additional startup time
+- **Memory Usage**: < 1MB additional memory
+- **Type Validation**: Cached after first load
+- **Production Optimized**: Skip validation with `DJANGO_CFG_SKIP_VALIDATION=1`
+
+## 🌟 Community
+
+- **🌐 Website**: [djangocfg.com](https://djangocfg.com/)
+- **📚 Documentation**: [docs.djangocfg.com](https://docs.djangocfg.com/)
+- **🐙 GitHub**: [github.com/reformsai/django-cfg](https://github.com/reformsai/django-cfg)
+- **📦 PyPI**: [pypi.org/project/django-cfg](https://pypi.org/project/django-cfg/)
+- **💬 Discord**: [Join our Discord](https://discord.gg/django-cfg)
+- **❓ Stack Overflow**: Tag questions with `django-cfg`
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- **Django** - The web framework for perfectionists with deadlines
+- **Pydantic** - Data validation using Python type hints
+- **Django Unfold** - Beautiful modern admin interface
+- **Dramatiq** - Fast and reliable background task processing
+
+---
+
+**Made with ❤️ by the Django-CFG Team**
+
+*Transform your Django development experience with type-safe configuration, AI agents, and enterprise integrations.*
+
+🚀 **[Get Started Now](https://docs.djangocfg.com/getting-started/installation)** | 📚 **[View Documentation](https://docs.djangocfg.com/)** | 🌐 **[Visit Website](https://djangocfg.com/)**