django-cfg 1.4.20__py3-none-any.whl → 1.4.23__py3-none-any.whl

django_cfg/modules/django_ipc_client/dashboard/UNFOLD_INTEGRATION.md

@@ -1,439 +0,0 @@
-# Unfold Admin Integration 🎨
-
-Complete guide for integrating RPC Dashboard with django-unfold admin interface.
-
----
-
-## ✨ Automatic Integration (New in v2.0)
-
-**Zero configuration required!** When you enable RPC, django-cfg automatically adds "Operations" section to Unfold navigation:
-
-```python
-# config.py
-from django_cfg import DjangoConfig
-from django_cfg.modules.django_cfg_rpc_client.config import DjangoCfgRPCConfig
-
-class MyConfig(DjangoConfig):
-    # Enable RPC module
-    django_cfg_rpc = DjangoCfgRPCConfig(
-        enabled=True,
-        redis_url="redis://localhost:6379/2",
-    )
-```
-
-**That's it!** Django-cfg automatically creates "Operations" section with:
-- ✅ RPC Dashboard (if RPC enabled)
-- ✅ Background Tasks (if tasks enabled)
-- ✅ Configuration (Constance)
-- ✅ Maintenance (if enabled)
-- ✅ Health Check
-
-**No URL configuration needed** - URLs are auto-registered via `get_django_cfg_urlpatterns()`
-
----
-
-## 🎨 Custom Navigation (Advanced)
-
-If you want to customize the navigation, override `unfold` config:
-
-### Option 1: Custom Section Name
-
-```python
-from django_cfg import UnfoldConfig, NavigationSection, NavigationItem, Icons
-
-class MyConfig(DjangoConfig):
-    django_cfg_rpc = DjangoCfgRPCConfig(enabled=True, redis_url="redis://localhost:6379/2")
-
-    # Override navigation
-    unfold = UnfoldConfig(
-        site_title="My Admin",
-        navigation=[
-            NavigationSection(
-                title="Monitoring",  # Custom name
-                items=[
-                    NavigationItem(
-                        title="RPC Dashboard",
-                        icon=Icons.MONITOR_HEART,
-                        link="/admin/rpc/"
-                    ),
-                ],
-            ),
-        ],
-    )
-```
-
-### Option 2: Manual URL Registration (Not Recommended)
-
-If not using django-cfg's automatic URL generation:
-
-```python
-# urls.py
-from django.urls import path, include
-
-urlpatterns = [
-    path('admin/', admin.site.urls),
-    path('admin/rpc/', include('django_cfg.modules.django_cfg_rpc_client.dashboard.urls')),
-]
-```
-
----
-
-## 📍 Navigation Placement
-
-### Option 1: Operations Section (Recommended)
-
-Combine RPC Dashboard with all operational tools for logical grouping:
-
-```python
-NavigationSection(
-    title="Operations",
-    items=[
-        NavigationItem(
-            title="RPC Dashboard",
-            icon=Icons.MONITOR_HEART,
-            link="/admin/rpc/"
-        ),
-        NavigationItem(
-            title="Background Tasks",
-            icon=Icons.TASK,
-            link="admin:django_dramatiq_task_changelist"
-        ),
-        NavigationItem(
-            title="Configuration",
-            icon=Icons.SETTINGS,
-            link="admin:constance_config_changelist"
-        ),
-        NavigationItem(
-            title="Maintenance",
-            icon=Icons.BUILD,
-            link="admin:maintenance_cloudflaresite_changelist"
-        ),
-    ],
-)
-```
-
-### Option 2: System/Admin Section
-
-```python
-NavigationSection(
-    title="System",
-    items=[
-        NavigationItem(title="Configuration", icon=Icons.SETTINGS, link="/admin/constance/config/"),
-        NavigationItem(title="RPC Dashboard", icon=Icons.MONITOR_HEART, link="/admin/rpc/"),
-        NavigationItem(title="Logs", icon=Icons.DESCRIPTION, link="/admin/logs/"),
-    ],
-)
-```
-
-### Option 3: Integrated with Content
-
-```python
-navigation=[
-    NavigationSection(
-        title="Content",
-        items=[
-            NavigationItem(title="Posts", icon=Icons.ARTICLE, link="admin:blog_post_changelist"),
-        ],
-    ),
-    NavigationSection(
-        title="Tools",
-        items=[
-            NavigationItem(title="RPC Dashboard", icon=Icons.INSIGHTS, link="/admin/rpc/"),
-            NavigationItem(title="Analytics", icon=Icons.ANALYTICS, link="/admin/analytics/"),
-        ],
-    ),
-]
-```
-
----
-
-## 🎨 Icon Options
-
-Material Design icons for RPC Dashboard:
-
-```python
-# Health & Monitoring (Recommended)
-icon=Icons.MONITOR_HEART      # ❤️ Heart monitor - best for health monitoring
-icon=Icons.HEALTH_AND_SAFETY  # 🏥 Health and safety
-icon=Icons.MEDICAL_SERVICES   # 🩺 Medical services
-
-# Analytics & Insights
-icon=Icons.INSIGHTS           # 💡 Insights - good for analytics
-icon=Icons.ANALYTICS          # 📊 Analytics charts
-icon=Icons.BAR_CHART          # 📊 Bar chart
-icon=Icons.DASHBOARD          # 📋 Dashboard
-
-# Activity & Timeline
-icon=Icons.TIMELINE           # 📈 Timeline activity
-icon=Icons.HISTORY            # 🕐 History/activity
-icon=Icons.UPDATE             # 🔄 Updates
-
-# Communication
-icon=Icons.WEBHOOK            # 🔗 Webhooks
-icon=Icons.API                # 🔌 API
-icon=Icons.CLOUD_SYNC         # ☁️ Cloud sync
-```
-
-### Icon Preview
-
-```python
-# Health monitoring focus
-NavigationItem(title="RPC Monitor", icon=Icons.MONITOR_HEART, link="/admin/rpc/")
-# → Best for: Health checks, system monitoring
-
-# Analytics focus
-NavigationItem(title="RPC Analytics", icon=Icons.INSIGHTS, link="/admin/rpc/")
-# → Best for: Statistics, performance metrics
-
-# Activity focus
-NavigationItem(title="RPC Activity", icon=Icons.TIMELINE, link="/admin/rpc/")
-# → Best for: Request logs, recent activity
-
-# Technical focus
-NavigationItem(title="RPC Dashboard", icon=Icons.API, link="/admin/rpc/")
-# → Best for: Developer tools, API monitoring
-```
-
----
-
-## 🔐 Access Control
-
-### Staff-Only Access (Default)
-
-```python
-NavigationItem(
-    title="RPC Dashboard",
-    icon=Icons.MONITOR_HEART,
-    link="/admin/rpc/",
-    # No permission = staff users only (is_staff=True)
-)
-```
-
-### Superuser-Only Access
-
-```python
-NavigationItem(
-    title="RPC Dashboard",
-    icon=Icons.MONITOR_HEART,
-    link="/admin/rpc/",
-    permission=lambda request: request.user.is_superuser
-)
-```
-
-### Custom Permission Check
-
-```python
-NavigationItem(
-    title="RPC Dashboard",
-    icon=Icons.MONITOR_HEART,
-    link="/admin/rpc/",
-    permission=lambda request: (
-        request.user.is_staff and
-        request.user.has_perm('monitoring.view_rpc')
-    )
-)
-```
-
----
-
-## 🏷️ Badge Support
-
-### Add "New" Badge
-
-```python
-NavigationItem(
-    title="RPC Dashboard",
-    icon=Icons.MONITOR_HEART,
-    link="/admin/rpc/",
-    badge="new"
-)
-```
-
-### Dynamic Badge (Alert Count)
-
-```python
-def get_rpc_navigation(request):
-    from django_cfg.modules.django_cfg_rpc_client.dashboard.monitor import RPCMonitor
-
-    monitor = RPCMonitor()
-    health = monitor.health_check()
-
-    # Show badge if Redis is down
-    badge = "!" if not health['redis_connected'] else None
-
-    return NavigationItem(
-        title="RPC Dashboard",
-        icon=Icons.MONITOR_HEART,
-        link="/admin/rpc/",
-        badge=badge
-    )
-
-# Use in navigation
-unfold: UnfoldConfig = UnfoldConfig(
-    sidebar={
-        "navigation": "myapp.navigation.get_rpc_navigation",
-    }
-)
-```
-
----
-
-## 🎯 Full Example
-
-Complete configuration with all django-cfg features:
-
-```python
-# config.py
-from django_cfg import (
-    DjangoConfig,
-    UnfoldConfig,
-    NavigationSection,
-    NavigationItem,
-    Icons,
-    DjangoCfgRPCConfig,
-    TaskConfig,
-    PaymentsConfig,
-)
-
-class ProductionConfig(DjangoConfig):
-    """Production configuration with monitoring."""
-
-    # === RPC Configuration ===
-    django_cfg_rpc: DjangoCfgRPCConfig = DjangoCfgRPCConfig(
-        enabled=True,
-        redis_url="redis://localhost:6379/2",
-        rpc_timeout=30,
-    )
-
-    # === Background Tasks ===
-    enable_tasks: bool = True
-
-    # === Payments ===
-    payments: PaymentsConfig = PaymentsConfig(enabled=True)
-
-    # === Unfold Admin ===
-    unfold: UnfoldConfig = UnfoldConfig(
-        site_title="Production Admin",
-        site_header="Production Dashboard",
-        theme='dark',
-
-        navigation=[
-            # Dashboard
-            NavigationSection(
-                title="Dashboard",
-                items=[
-                    NavigationItem(
-                        title="Overview",
-                        icon=Icons.DASHBOARD,
-                        link="/admin/"
-                    ),
-                ],
-            ),
-
-            # Content Management
-            NavigationSection(
-                title="Content",
-                items=[
-                    NavigationItem(title="Posts", icon=Icons.ARTICLE, link="admin:blog_post_changelist"),
-                    NavigationItem(title="Pages", icon=Icons.DESCRIPTION, link="admin:pages_page_changelist"),
-                ],
-            ),
-
-            # E-commerce
-            NavigationSection(
-                title="E-commerce",
-                items=[
-                    NavigationItem(title="Products", icon=Icons.INVENTORY, link="admin:shop_product_changelist"),
-                    NavigationItem(title="Orders", icon=Icons.SHOPPING_CART, link="admin:shop_order_changelist"),
-                    NavigationItem(title="Payments", icon=Icons.PAYMENT, link="admin:payments_payment_changelist"),
-                ],
-            ),
-
-            # Operations (RPC Dashboard + System Tools)
-            NavigationSection(
-                title="Operations",
-                items=[
-                    NavigationItem(
-                        title="RPC Dashboard",
-                        icon=Icons.MONITOR_HEART,
-                        link="/admin/rpc/",
-                        permission=lambda request: request.user.is_staff
-                    ),
-                    NavigationItem(
-                        title="Background Tasks",
-                        icon=Icons.TASK,
-                        link="admin:django_dramatiq_task_changelist",
-                        permission=lambda request: request.user.is_staff
-                    ),
-                    NavigationItem(
-                        title="Configuration",
-                        icon=Icons.SETTINGS,
-                        link="admin:constance_config_changelist",
-                        permission=lambda request: request.user.is_staff
-                    ),
-                    NavigationItem(
-                        title="Maintenance",
-                        icon=Icons.BUILD,
-                        link="admin:maintenance_cloudflaresite_changelist",
-                        permission=lambda request: request.user.is_superuser
-                    ),
-                ],
-            ),
-        ],
-    )
-```
-
----
-
-## 🧪 Testing Integration
-
-### Test Navigation Display
-
-```python
-from django.test import TestCase, RequestFactory
-from django.contrib.auth import get_user_model
-
-User = get_user_model()
-
-class UnfoldNavigationTest(TestCase):
-    def setUp(self):
-        self.factory = RequestFactory()
-        self.staff_user = User.objects.create_user(
-            username='staff',
-            is_staff=True
-        )
-        self.regular_user = User.objects.create_user(
-            username='user',
-            is_staff=False
-        )
-
-    def test_rpc_dashboard_visible_to_staff(self):
-        """Test RPC Dashboard appears in navigation for staff users."""
-        request = self.factory.get('/admin/')
-        request.user = self.staff_user
-
-        # Navigation rendering logic
-        # Verify RPC Dashboard link is present
-
-    def test_rpc_dashboard_hidden_from_regular_users(self):
-        """Test RPC Dashboard hidden from non-staff users."""
-        request = self.factory.get('/admin/')
-        request.user = self.regular_user
-
-        # Verify RPC Dashboard link is NOT present
-```
-
----
-
-## 📚 Related Documentation
-
-- [Unfold Admin Guide](/docs/features/modules/unfold/overview.md)
-- [RPC Dashboard README](./README.md)
-- [Icons Reference](/docs/fundamentals/icons.md)
-- [Navigation Configuration](/docs/guides/admin-interface.md)
-
----
-
-**Last Updated**: 2025-10-03
-**Version**: 2.0
-**Compatible with**: django-unfold 0.x, django-cfg 2.x

django_cfg/modules/django_ipc_client/dashboard/__init__.py

@@ -1,11 +0,0 @@
-"""
-RPC Dashboard for django-cfg-rpc-client.
-
-Provides real-time monitoring and visualization of RPC activity.
-"""
-
-default_app_config = 'django_cfg.modules.django_ipc_client.dashboard.apps.RPCDashboardConfig'
-
-from .monitor import RPCMonitor
-
-__all__ = ['RPCMonitor']

django_cfg/modules/django_ipc_client/dashboard/apps.py

@@ -1,22 +0,0 @@
-"""
-Django AppConfig for RPC Dashboard.
-
-Enables template and static file discovery.
-"""
-
-from django.apps import AppConfig
-
-
-class RPCDashboardConfig(AppConfig):
-    """
-    RPC Dashboard application configuration.
-
-    Enables:
-    - Template discovery from templates/django_ipc_dashboard/
-    - Static file discovery from static/django_ipc_dashboard/
-    """
-
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'django_cfg.modules.django_ipc_client.dashboard'
-    label = 'django_ipc_dashboard'
-    verbose_name = 'Django-CFG RPC Dashboard'

django_cfg/modules/django_ipc_client/dashboard/templates/django_ipc_dashboard/dashboard.html

@@ -1,200 +0,0 @@
-{% extends 'django_ipc_dashboard/base.html' %}
-{% load static %}
-
-{% block title %}Dashboard{% endblock %}
-
-{% block content %}
-<!-- Overview Stats Cards -->
-<div class="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-4 gap-6 mb-8">
-    <!-- Total Requests -->
-    <div class="stat-card bg-gray-800 rounded-lg p-6 border border-gray-700">
-        <div class="flex items-center justify-between mb-4">
-            <span class="material-icons text-4xl text-blue-400">bar_chart</span>
-            <span class="text-xs text-gray-400">Today</span>
-        </div>
-        <h3 class="text-2xl font-bold text-white mb-1" id="total-requests">
-            {{ overview_stats.total_requests_today|default:"0" }}
-        </h3>
-        <p class="text-sm text-gray-400">Total Requests</p>
-    </div>
-
-    <!-- Active Methods -->
-    <div class="stat-card bg-gray-800 rounded-lg p-6 border border-gray-700">
-        <div class="flex items-center justify-between mb-4">
-            <span class="material-icons text-4xl text-green-400">functions</span>
-            <span class="text-xs text-gray-400">Active</span>
-        </div>
-        <h3 class="text-2xl font-bold text-white mb-1" id="active-methods-count">
-            {{ overview_stats.active_methods|length|default:"0" }}
-        </h3>
-        <p class="text-sm text-gray-400">Active Methods</p>
-    </div>
-
-    <!-- Avg Response Time -->
-    <div class="stat-card bg-gray-800 rounded-lg p-6 border border-gray-700">
-        <div class="flex items-center justify-between mb-4">
-            <span class="material-icons text-4xl text-yellow-400">timer</span>
-            <span class="text-xs text-gray-400">Average</span>
-        </div>
-        <h3 class="text-2xl font-bold text-white mb-1" id="avg-response-time">
-            {{ overview_stats.avg_response_time_ms|default:"0" }}<span class="text-lg text-gray-400">ms</span>
-        </h3>
-        <p class="text-sm text-gray-400">Response Time</p>
-    </div>
-
-    <!-- Success Rate -->
-    <div class="stat-card bg-gray-800 rounded-lg p-6 border border-gray-700">
-        <div class="flex items-center justify-between mb-4">
-            <span class="material-icons text-4xl text-purple-400">check_circle</span>
-            <span class="text-xs text-gray-400">Rate</span>
-        </div>
-        <h3 class="text-2xl font-bold text-white mb-1" id="success-rate">
-            {{ overview_stats.success_rate|default:"0" }}<span class="text-lg text-gray-400">%</span>
-        </h3>
-        <p class="text-sm text-gray-400">Success Rate</p>
-    </div>
-</div>
-
-<!-- System Status -->
-<div class="bg-gray-800 rounded-lg p-6 border border-gray-700 mb-8">
-    <h2 class="text-xl font-bold text-white mb-4 flex items-center">
-        <span class="material-icons mr-2">health_and_safety</span>
-        System Status
-    </h2>
-    <div id="system-status" class="grid grid-cols-1 md:grid-cols-3 gap-4">
-        <!-- Redis Status -->
-        <div class="flex items-center space-x-3">
-            <span class="material-icons {% if health.redis_connected %}text-green-500{% else %}text-red-500{% endif %}">
-                {% if health.redis_connected %}check_circle{% else %}cancel{% endif %}
-            </span>
-            <div>
-                <p class="text-sm font-medium text-white">Redis</p>
-                <p class="text-xs text-gray-400">
-                    {% if health.redis_connected %}Connected (DB 2){% else %}Disconnected{% endif %}
-                </p>
-            </div>
-        </div>
-
-        <!-- Stream Status -->
-        <div class="flex items-center space-x-3">
-            <span class="material-icons {% if health.stream_exists %}text-green-500{% else %}text-gray-500{% endif %}">
-                {% if health.stream_exists %}stream{% else %}stream_off{% endif %}
-            </span>
-            <div>
-                <p class="text-sm font-medium text-white">Request Stream</p>
-                <p class="text-xs text-gray-400">
-                    {% if health.stream_exists %}{{ health.stream_length }} entries{% else %}Not initialized{% endif %}
-                </p>
-            </div>
-        </div>
-
-        <!-- Activity Status -->
-        <div class="flex items-center space-x-3">
-            <span class="material-icons {% if health.recent_activity %}text-green-500{% else %}text-yellow-500{% endif %}">
-                {% if health.recent_activity %}notifications_active{% else %}notifications_paused{% endif %}
-            </span>
-            <div>
-                <p class="text-sm font-medium text-white">Recent Activity</p>
-                <p class="text-xs text-gray-400">
-                    {% if health.recent_activity %}Active (last 5 min){% else %}No recent activity{% endif %}
-                </p>
-            </div>
-        </div>
-    </div>
-</div>
-
-<!-- Tabs Navigation -->
-<div class="border-b border-gray-700 mb-6">
-    <nav class="flex space-x-4">
-        <button class="tab-button active px-4 py-2 text-blue-400 border-b-2 border-blue-400 font-medium" data-tab="overview">
-            Overview
-        </button>
-        <button class="tab-button px-4 py-2 text-gray-400 hover:text-gray-300 border-b-2 border-transparent font-medium" data-tab="requests">
-            Recent Requests
-        </button>
-        <button class="tab-button px-4 py-2 text-gray-400 hover:text-gray-300 border-b-2 border-transparent font-medium" data-tab="notifications">
-            Notifications
-        </button>
-        <button class="tab-button px-4 py-2 text-gray-400 hover:text-gray-300 border-b-2 border-transparent font-medium" data-tab="methods">
-            Methods
-        </button>
-    </nav>
-</div>
-
-<!-- Tab Content -->
-<div class="tab-content">
-    <!-- Overview Tab (Active by default) -->
-    <div id="overview-tab" class="tab-panel">
-        <div class="bg-gray-800 rounded-lg p-6 border border-gray-700">
-            <h3 class="text-lg font-bold text-white mb-4">Top Method</h3>
-            <p class="text-gray-300" id="top-method">
-                {% if overview_stats.top_method %}
-                    <code class="bg-gray-700 px-2 py-1 rounded text-blue-300">{{ overview_stats.top_method }}</code>
-                {% else %}
-                    No data available
-                {% endif %}
-            </p>
-        </div>
-    </div>
-
-    <!-- Recent Requests Tab -->
-    <div id="requests-tab" class="tab-panel hidden">
-        <div class="bg-gray-800 rounded-lg border border-gray-700 overflow-hidden">
-            <table class="w-full">
-                <thead class="bg-gray-900">
-                    <tr>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Time</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Method</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Correlation ID</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Params</th>
-                    </tr>
-                </thead>
-                <tbody id="requests-table-body" class="divide-y divide-gray-700">
-                    <tr>
-                        <td colspan="4" class="px-4 py-8 text-center text-gray-400">
-                            Loading...
-                        </td>
-                    </tr>
-                </tbody>
-            </table>
-        </div>
-    </div>
-
-    <!-- Notifications Tab -->
-    <div id="notifications-tab" class="tab-panel hidden">
-        <div class="bg-gray-800 rounded-lg p-6 border border-gray-700">
-            <h3 class="text-lg font-bold text-white mb-4">Notification Statistics</h3>
-            <div id="notification-stats-content">
-                <p class="text-gray-400">Loading...</p>
-            </div>
-        </div>
-    </div>
-
-    <!-- Methods Tab -->
-    <div id="methods-tab" class="tab-panel hidden">
-        <div class="bg-gray-800 rounded-lg border border-gray-700 overflow-hidden">
-            <table class="w-full">
-                <thead class="bg-gray-900">
-                    <tr>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Method</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Count</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Percentage</th>
-                        <th class="px-4 py-3 text-left text-xs font-medium text-gray-400 uppercase">Avg Time</th>
-                    </tr>
-                </thead>
-                <tbody id="methods-table-body" class="divide-y divide-gray-700">
-                    <tr>
-                        <td colspan="4" class="px-4 py-8 text-center text-gray-400">
-                            Loading...
-                        </td>
-                    </tr>
-                </tbody>
-            </table>
-        </div>
-    </div>
-</div>
-{% endblock %}
-
-{% block extra_js %}
-<script src="{% static 'django_ipc_dashboard/js/dashboard.js' %}"></script>
-{% endblock %}

django_cfg/modules/django_ipc_client/dashboard/urls.py

@@ -1,22 +0,0 @@
-"""
-URL patterns for RPC Dashboard.
-
-Mount at: /admin/rpc/ or custom path
-"""
-
-from django.urls import path
-from . import views
-
-app_name = 'django_ipc_dashboard'
-
-urlpatterns = [
-    # Main dashboard page
-    path('', views.dashboard_view, name='dashboard'),
-
-    # API endpoints
-    path('api/overview/', views.api_overview_stats, name='api_overview'),
-    path('api/requests/', views.api_recent_requests, name='api_requests'),
-    path('api/notifications/', views.api_notification_stats, name='api_notifications'),
-    path('api/methods/', views.api_method_stats, name='api_methods'),
-    path('api/health/', views.api_health_check, name='api_health'),
-]