django-cfg 1.4.116__py3-none-any.whl → 1.5.14__py3-none-any.whl

django_cfg/modules/django_admin/utils/CODE_BLOCK_DOCS.md

@@ -1,396 +0,0 @@
-# Code Block Methods Documentation
-
-New methods added to `HtmlBuilder` for displaying code in Django Admin.
-
-## Methods Added
-
-### 1. `code()` - Inline Code
-
-Display short code snippets inline.
-
-**Signature:**
-```python
-def code(text: Any, css_class: str = "") -> SafeString
-```
-
-**Parameters:**
-- `text`: Code text to display
-- `css_class`: Additional CSS classes (optional)
-
-**Usage:**
-```python
-from django_cfg.modules.django_admin.base import PydanticAdmin
-
-class MyAdmin(PydanticAdmin):
-    @computed_field("Command")
-    def command_display(self, obj):
-        return self.html.code(obj.full_command)
-```
-
-**Examples:**
-```python
-# File path
-self.html.code("/path/to/file")
-
-# Command
-self.html.code("python manage.py migrate")
-
-# Configuration value
-self.html.code("DEBUG=True")
-```
-
-**Renders as:**
-```html
-<code class="font-mono text-xs bg-base-100 dark:bg-base-800 px-1.5 py-0.5 rounded">
-    /path/to/file
-</code>
-```
-
----
-
-### 2. `code_block()` - Multi-line Code Block
-
-Display multi-line code with syntax highlighting hints, scrolling, and color variants.
-
-**Signature:**
-```python
-def code_block(
-    text: Any,
-    language: Optional[str] = None,
-    max_height: Optional[str] = None,
-    variant: str = "default"
-) -> SafeString
-```
-
-**Parameters:**
-- `text`: Code content (multi-line supported)
-- `language`: Programming language hint (`"json"`, `"python"`, `"bash"`, etc.) - for future syntax highlighting
-- `max_height`: Maximum height with overflow scroll (e.g., `"400px"`, `"20rem"`)
-- `variant`: Color variant - `"default"`, `"warning"`, `"danger"`, `"success"`, `"info"`
-
-**Usage:**
-```python
-from django_cfg.modules.django_admin.base import PydanticAdmin
-import json
-
-class MyAdmin(PydanticAdmin):
-    @computed_field("Configuration")
-    def config_display(self, obj):
-        if not obj.config:
-            return self.html.empty()
-
-        return self.html.code_block(
-            json.dumps(obj.config, indent=2),
-            language="json"
-        )
-
-    @computed_field("Standard Output")
-    def stdout_display(self, obj):
-        if not obj.stdout:
-            return self.html.empty()
-
-        return self.html.code_block(
-            obj.stdout,
-            max_height="400px"
-        )
-
-    @computed_field("Error Message")
-    def error_display(self, obj):
-        if not obj.error_message:
-            return self.html.empty()
-
-        return self.html.code_block(
-            obj.error_message,
-            max_height="200px",
-            variant="danger"
-        )
-```
-
-**Examples:**
-
-#### JSON Display
-```python
-# Display JSON configuration
-self.html.code_block(
-    json.dumps({"key": "value", "nested": {"foo": "bar"}}, indent=2),
-    language="json"
-)
-```
-
-#### Log Output with Scrolling
-```python
-# Display command output with scroll
-self.html.code_block(
-    "Line 1\nLine 2\nLine 3\n...",
-    max_height="400px"
-)
-```
-
-#### Error Messages
-```python
-# Display error with danger styling
-self.html.code_block(
-    "Traceback (most recent call last):\n  File ...",
-    variant="danger",
-    max_height="300px"
-)
-```
-
-#### Warnings
-```python
-# Display warnings with warning styling
-self.html.code_block(
-    "Warning: This is deprecated\nUse new_method() instead",
-    variant="warning"
-)
-```
-
-**Renders as:**
-```html
-<!-- Default variant -->
-<pre class="font-mono text-xs whitespace-pre-wrap break-words border rounded-md p-3
-            bg-base-50 dark:bg-base-900 border-base-200 dark:border-base-700"
-     style="max-height: 400px; overflow-y: auto;">
-    <code>{"key": "value"}</code>
-</pre>
-
-<!-- Danger variant -->
-<pre class="font-mono text-xs whitespace-pre-wrap break-words border rounded-md p-3
-            bg-danger-50 dark:bg-danger-900/20 border-danger-200 dark:border-danger-700"
-     style="max-height: 200px; overflow-y: auto;">
-    <code>Error: Something went wrong</code>
-</pre>
-```
-
----
-
-## Color Variants
-
-| Variant | Background | Border | Use Case |
-|---------|-----------|--------|----------|
-| `default` | Gray | Gray | Standard code, JSON, logs |
-| `warning` | Yellow/Orange | Yellow/Orange | Warnings, stderr output |
-| `danger` | Red | Red | Errors, exceptions, failures |
-| `success` | Green | Green | Success messages, confirmations |
-| `info` | Blue | Blue | Info messages, metadata |
-
----
-
-## Use Cases
-
-### 1. Command Execution Logs
-```python
-@computed_field("Output")
-def output_display(self, obj):
-    return self.html.code_block(
-        obj.stdout,
-        max_height="400px"
-    )
-```
-
-### 2. JSON Configuration
-```python
-@computed_field("Settings")
-def settings_display(self, obj):
-    return self.html.code_block(
-        json.dumps(obj.settings, indent=2),
-        language="json"
-    )
-```
-
-### 3. Error Details
-```python
-@computed_field("Error")
-def error_display(self, obj):
-    if not obj.error_message:
-        return self.html.empty()
-
-    return self.html.code_block(
-        obj.error_message,
-        max_height="300px",
-        variant="danger"
-    )
-```
-
-### 4. API Request/Response
-```python
-@computed_field("Request Body")
-def request_body_display(self, obj):
-    return self.html.code_block(
-        obj.request_body,
-        language="json",
-        max_height="300px"
-    )
-```
-
-### 5. SQL Queries
-```python
-@computed_field("Query")
-def query_display(self, obj):
-    return self.html.code_block(
-        obj.sql_query,
-        language="sql",
-        max_height="200px"
-    )
-```
-
----
-
-## Styling Details
-
-### Tailwind Classes Used
-
-**Base Classes:**
-- `font-mono` - Monospace font
-- `text-xs` - Small text size
-- `whitespace-pre-wrap` - Preserve whitespace, wrap long lines
-- `break-words` - Break long words
-- `border` - Border
-- `rounded-md` - Rounded corners
-- `p-3` - Padding
-
-**Variant-specific:**
-- Light mode: `bg-{variant}-50 border-{variant}-200`
-- Dark mode: `dark:bg-{variant}-900/20 dark:border-{variant}-700`
-
-**Scrolling:**
-- Applied via inline `style` attribute
-- `max-height` and `overflow-y: auto`
-
----
-
-## Implementation Notes
-
-1. **Escaping**: All text is automatically escaped using Django's `escape()` to prevent XSS
-2. **SafeString**: Returns Django's `SafeString` for safe HTML rendering
-3. **Dark Mode**: Full dark mode support with Tailwind's dark: prefix
-4. **Responsive**: Works on mobile with `break-words` and `whitespace-pre-wrap`
-5. **Future-proof**: `language` parameter allows for syntax highlighting integration later
-
----
-
-## Complete Example: Command Execution Admin
-
-```python
-from django.contrib import admin
-from django_cfg.modules.django_admin import (
-    AdminConfig, BadgeField, DateTimeField, Icons, computed_field
-)
-from django_cfg.modules.django_admin.base import PydanticAdmin
-import json
-
-commandexecution_config = AdminConfig(
-    model=CommandExecution,
-    list_display=["id", "command", "status", "created_at"],
-    readonly_fields=[
-        "command_display",
-        "args_display",
-        "stdout_display",
-        "stderr_display",
-        "error_display",
-    ],
-)
-
-@admin.register(CommandExecution)
-class CommandExecutionAdmin(PydanticAdmin):
-    config = commandexecution_config
-
-    @computed_field("Command")
-    def command_display(self, obj):
-        """Inline code for command."""
-        return self.html.code(obj.full_command)
-
-    @computed_field("Arguments")
-    def args_display(self, obj):
-        """JSON code block for args."""
-        if not obj.args:
-            return self.html.empty()
-
-        return self.html.code_block(
-            json.dumps(obj.args, indent=2),
-            language="json"
-        )
-
-    @computed_field("Standard Output")
-    def stdout_display(self, obj):
-        """Scrollable output."""
-        if not obj.stdout:
-            return self.html.empty()
-
-        return self.html.code_block(
-            obj.stdout,
-            max_height="400px"
-        )
-
-    @computed_field("Standard Error")
-    def stderr_display(self, obj):
-        """Warning-styled error output."""
-        if not obj.stderr:
-            return self.html.empty()
-
-        return self.html.code_block(
-            obj.stderr,
-            max_height="400px",
-            variant="warning"
-        )
-
-    @computed_field("Error Message")
-    def error_display(self, obj):
-        """Danger-styled error message."""
-        if not obj.error_message:
-            return self.html.empty()
-
-        return self.html.code_block(
-            obj.error_message,
-            max_height="200px",
-            variant="danger"
-        )
-```
-
----
-
-## Testing
-
-```python
-# Test inline code
-assert 'font-mono' in str(html.code("test"))
-
-# Test code block
-assert '<pre' in str(html.code_block("test"))
-assert 'overflow-y: auto' in str(html.code_block("test", max_height="400px"))
-
-# Test variants
-assert 'bg-danger' in str(html.code_block("error", variant="danger"))
-assert 'bg-warning' in str(html.code_block("warn", variant="warning"))
-```
-
----
-
-## Migration from Old Format
-
-**Before (manual HTML):**
-```python
-def output_display(self, obj):
-    return format_html(
-        '<pre style="max-height: 400px; overflow-y: auto; '
-        'background: #f8f9fa; padding: 10px; border-radius: 4px;">{}</pre>',
-        obj.stdout
-    )
-```
-
-**After (with code_block):**
-```python
-def output_display(self, obj):
-    return self.html.code_block(
-        obj.stdout,
-        max_height="400px"
-    )
-```
-
-Benefits:
-- ✅ Cleaner, more readable code
-- ✅ Consistent styling across project
-- ✅ Dark mode support
-- ✅ Proper escaping
-- ✅ Tailwind CSS classes
-- ✅ Variant support for different contexts

django_cfg/modules/django_logging/FIXES_SUMMARY.md

@@ -1,276 +0,0 @@
-# Logging Fixes Summary - 2025-10-03
-
-## Problem
-
-When `debug: false` in configuration, INFO-level logs were still appearing in console output, cluttering production/non-debug environments with unnecessary information.
-
-### Example of Issue
-
-**Before:**
-```
-[django-cfg] Modular logging configured successfully! Debug: False
-[10/02/25 17:59:07] INFO     🚀 Generated DRF + Spectacular settings
-[10/02/25 17:59:07] INFO     🚀 Auto-configured default pagination
-[10/02/25 17:59:07] INFO     🎯 Smart queue detection: [...]
-[10/02/25 17:59:07] INFO     ✅ Generated Dramatiq settings
-```
-
-**After:**
-```
-[django-cfg] Modular logging configured successfully! Debug: False
-✅ Integrated 10 Revolution URL patterns
-[Shows only startup tables, no INFO logs]
-```
-
-## Root Cause
-
-Two logging systems were not respecting the `debug` configuration:
-
-1. **Django Logger** (`django_logger.py`)
-   - Default level was `logging.INFO`
-   - Should have been `logging.WARNING` when debug=False
-
-2. **Rich Logger** (`logger.py`)
-   - Default level was `logging.INFO`
-   - RichHandler not configured with proper level
-
-## Solutions Applied
-
-### 1. Fixed django_logger.py
-
-**File:** `/django_cfg/modules/django_logging/django_logger.py`
-
-**Changes:**
-```python
-# Lines 59-73: Changed log level based on debug mode
-django_handler.setLevel(logging.DEBUG if debug else logging.WARNING)
-console_handler.setLevel(logging.DEBUG if debug else logging.WARNING)
-root_logger.setLevel(logging.DEBUG if debug else logging.WARNING)
-
-# Line 89: Fixed fallback level
-logging.basicConfig(
-    level=logging.DEBUG if debug else logging.WARNING,  # Was: INFO
-    ...
-)
-
-# Line 132: Fixed file handler level
-file_handler.setLevel(logging.DEBUG if debug else logging.WARNING)  # Was: INFO
-```
-
-### 2. Fixed Rich Logger
-
-**File:** `/django_cfg/modules/django_logging/logger.py`
-
-**Changes:**
-```python
-# Line 26: Changed default level
-DEFAULT_LEVEL = logging.WARNING  # Was: logging.INFO
-
-# Lines 86-94: Added config-aware debug detection
-def _setup_logger(self, debug: bool = None, use_rich: bool = True) -> None:
-    if debug is None:
-        # Try to get debug from django_cfg config first
-        try:
-            from django_cfg.core.state import get_current_config
-            config = get_current_config()
-            debug = config.debug if config and hasattr(config, 'debug') else False
-        except Exception:
-            # Fallback to environment variable
-            debug = os.environ.get("DEBUG", "false").lower() == "true"
-
-# Lines 101-117: Set handler levels properly
-handler = RichHandler(
-    console=console,
-    show_time=True,
-    show_path=False,
-    markup=True,
-    rich_tracebacks=True,
-    level=log_level,  # NEW: Respect debug mode
-)
-handler.setLevel(log_level)  # NEW: Explicit level set
-```
-
-### 3. Fixed Dashboard Debug Rendering
-
-**File:** `/django_cfg/modules/django_unfold/callbacks/main.py`
-
-**Changes:**
-```python
-# Lines 63-65: Added debug logging and proper checks
-debug_enabled = config and config.debug
-logger.info(f"[DEBUG MODE] Dashboard rendering with debug={debug_enabled} (config.debug={getattr(config, 'debug', 'N/A')})")
-
-# Lines 111-112, 120-121, etc.: Only save renders when debug=True
-if config and config.debug:
-    save_section_render('overview', overview_section)
-```
-
-### 4. Fixed Debug Config in YAML
-
-**File:** `/django_cfg_example/django/api/environment/config.dev.yaml`
-
-**Changes:**
-```yaml
-# Line 6: Changed from true to false
-debug: false  # Was: true
-```
-
-## Verification
-
-### Test: Start Server with debug=False
-
-```bash
-cd /django_cfg_example/django
-poetry run python manage.py runserver
-```
-
-**Expected Output:**
-- ✅ Shows: `[django-cfg] Modular logging configured successfully! Debug: False`
-- ✅ Shows: Startup configuration tables (apps, endpoints, etc.)
-- ❌ Does NOT show: `INFO` log lines
-- ✅ Shows only: `WARNING`, `ERROR`, `CRITICAL` logs
-
-### Test: Start Server with debug=True
-
-Change `config.dev.yaml`:
-```yaml
-debug: true
-```
-
-**Expected Output:**
-- ✅ Shows: `[django-cfg] Modular logging configured successfully! Debug: True`
-- ✅ Shows: ALL log lines including `INFO`, `DEBUG`
-- ✅ Shows: Rich-formatted colored logs
-
-## Log Level Matrix
-
-| config.debug | Console Level | File Level | What You See |
-|--------------|---------------|------------|--------------|
-| `true` | DEBUG | DEBUG | All logs: DEBUG, INFO, WARNING, ERROR, CRITICAL |
-| `false` | WARNING | WARNING | Only: WARNING, ERROR, CRITICAL |
-
-## Files Modified
-
-1. `/django_cfg/modules/django_logging/django_logger.py`
-   - Changed default level to WARNING
-   - Added config.debug detection
-   - Set handler levels properly
-
-2. `/django_cfg/modules/django_logging/logger.py`
-   - Changed DEFAULT_LEVEL to logging.WARNING
-   - Added config-aware debug detection
-   - Set RichHandler level
-
-3. `/django_cfg/modules/django_unfold/callbacks/main.py`
-   - Added debug mode logging
-   - Fixed debug render conditionals
-
-4. `/django_cfg_example/django/api/environment/config.dev.yaml`
-   - Set debug: false for testing
-
-5. `/django_cfg/templates/admin/sections/overview_section.html`
-   - Temporarily disabled components with {% endcomponent %} errors
-
-## Benefits
-
-### For Development (debug=True)
-- ✅ Verbose logging for debugging
-- ✅ All INFO messages visible
-- ✅ Rich formatting for readability
-
-### For Production (debug=False)
-- ✅ Clean console output
-- ✅ Only warnings and errors shown
-- ✅ Easier to spot real issues
-- ✅ Less log noise
-- ✅ Better performance (fewer log operations)
-
-## Documentation Created
-
-1. **LOGGING_GUIDE.md** - Comprehensive logging strategy guide
-   - How debug control works
-   - Usage examples
-   - Best practices
-   - Troubleshooting
-
-2. **CHARTS_GUIDE.md** - Chart.js integration guide (created earlier)
-   - Fixed container height issue
-   - Complete data flow documentation
-
-## Related Fixes
-
-### Template Error Fix
-
-Temporarily disabled components using `{% endcomponent %}` tags:
-- `system_metrics.html`
-- `activity_tracker.html`
-
-These need Unfold component library or conversion to standard includes.
-
-### Debug Renders Fix
-
-Debug dashboard renders now only saved when `debug=True`:
-```python
-if config and config.debug:
-    save_section_render('section_name', html_content)
-```
-
-## Testing Checklist
-
-- [x] Server starts without INFO logs when debug=False
-- [x] Server shows INFO logs when debug=True
-- [x] File logs respect debug level
-- [x] Console logs respect debug level
-- [x] Dashboard renders only saved when debug=True
-- [x] No errors in template rendering
-- [x] Charts display correctly
-
-## Migration Guide
-
-For developers using old logging:
-
-**Before:**
-```python
-import logging
-logger = logging.getLogger(__name__)
-logger.info("This always shows")  # Problem!
-```
-
-**After:**
-```python
-from django_cfg.modules.django_logging import get_logger
-logger = get_logger(__name__)
-logger.info("This respects debug mode")  # Fixed!
-```
-
-## Performance Impact
-
-### Before (debug=False but showing INFO logs)
-- 50+ INFO log operations during startup
-- Console cluttered with non-essential info
-- Harder to spot actual issues
-
-### After (debug=False, WARNING+ only)
-- ~5 WARNING/ERROR log operations during startup
-- Clean console output
-- Easier monitoring
-- ~10x fewer log operations
-
-## Next Steps
-
-### Short Term
-1. ✅ Fix remaining template component errors
-2. ✅ Test with debug=true to verify all logs still work
-3. ✅ Update documentation
-
-### Long Term
-1. Migrate all code to use `get_logger()` instead of `logging.getLogger()`
-2. Add structured logging for better production analysis
-3. Consider log aggregation (Sentry, ELK, etc.)
-
----
-
-**Fixed By:** Claude Code
-**Date:** 2025-10-03
-**Issue:** INFO logs appearing when debug=False
-**Status:** ✅ Resolved