django-cfg 1.4.120__py3-none-any.whl → 1.5.2__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_q2/README.md

@@ -1,140 +0,0 @@
-# Django-Q2 Module
-
-Автоматическая синхронизация расписаний Django-Q2 из конфига в базу данных.
-
-## Зачем это нужно?
-
-Django-Q2 хранит расписания в базе данных, но **не создаёт их автоматически** из конфига.
-Этот модуль решает эту проблему - синхронизирует расписания после каждой миграции.
-
-## Использование
-
-### 1. Включи Django-Q2 в конфиге
-
-```python
-# config.py
-from django_cfg.models.django import DjangoQ2Config
-
-django_q2 = DjangoQ2Config(
-    enabled=True,  # ← Автоматически добавит django_q и django_cfg.modules.django_q2 в INSTALLED_APPS
-    schedules=[...]
-)
-```
-
-**Модуль подключается автоматически!** Не нужно вручную добавлять в INSTALLED_APPS.
-
-### 2. Определи расписания в конфиге
-
-```python
-from django_cfg.models.django import DjangoQ2Config, DjangoQ2ScheduleConfig
-
-django_q2 = DjangoQ2Config(
-    enabled=True,
-    schedules=[
-        DjangoQ2ScheduleConfig(
-            name="Sync balances hourly",
-            schedule_type="hourly",
-            command="sync_account_balances",
-            command_args=["--verbose"],
-        ),
-        DjangoQ2ScheduleConfig(
-            name="Cleanup daily",
-            schedule_type="cron",
-            cron="0 2 * * *",  # 2 AM каждый день
-            command="cleanup_old_data",
-            command_kwargs={"days": 30},
-        ),
-    ],
-)
-```
-
-### 3. Запусти миграции
-
-```bash
-python manage.py migrate
-```
-
-**Вывод:**
-```
-Running migrations:
-  ...
-  Syncing 2 Django-Q2 schedule(s)...
-    ✓ Created schedule: Sync balances hourly
-    ✓ Created schedule: Cleanup daily
-  ✅ Django-Q2 schedules synced: 2 created, 0 updated
-```
-
-### 4. Запусти qcluster
-
-```bash
-python manage.py qcluster
-```
-
-Готово! Расписания автоматически синхронизированы и работают.
-
-## Как это работает?
-
-1. **Модуль подключается** к сигналу `post_migrate`
-2. **После миграций** автоматически:
-   - Читает расписания из конфига
-   - Создаёт/обновляет их в базе данных (Schedule model)
-3. **Django-Q2 читает** расписания из базы и выполняет задачи
-
-## Ручная синхронизация (опционально)
-
-Если нужно синхронизировать без миграций:
-
-```bash
-python manage.py sync_django_q_schedules
-
-# Или с --dry-run для проверки:
-python manage.py sync_django_q_schedules --dry-run
-```
-
-## Безопасность
-
-- ✅ **Идемпотентность**: можно запускать много раз, не создаст дубликаты
-- ✅ **Без race conditions**: синхронизация происходит один раз за цикл миграций
-- ✅ **Graceful degradation**: если Django-Q2 не установлен, модуль просто молча пропустит синхронизацию
-- ✅ **Logging**: все операции логируются для отладки
-
-## Преимущества перед ручной синхронизацией
-
-| Аспект | Ручная синхронизация | Модуль |
-|--------|---------------------|--------|
-| Автоматизация | Нужно помнить запускать | Автоматически |
-| Деплой | Легко забыть | Всегда синхронизировано |
-| CI/CD | Нужно добавлять в скрипты | Работает из коробки |
-| Ошибки | Легко пропустить | Логи миграций |
-
-## Troubleshooting
-
-### Расписания не создаются
-
-Проверь:
-1. Модуль добавлен в INSTALLED_APPS
-2. `django_q2.enabled = True` в конфиге
-3. В конфиге есть расписания
-4. Миграции запущены: `python manage.py migrate`
-
-### Расписания не обновляются
-
-Запусти миграции повторно или используй ручную синхронизацию:
-```bash
-python manage.py migrate --run-syncdb
-# или
-python manage.py sync_django_q_schedules
-```
-
-### Логи синхронизации
-
-Включи DEBUG логи:
-```python
-LOGGING = {
-    'loggers': {
-        'django_cfg.modules.django_q2': {
-            'level': 'DEBUG',
-        },
-    },
-}
-```

django_cfg/modules/django_q2/__init__.py

@@ -1,8 +0,0 @@
-"""
-Django-Q2 module for django-cfg.
-
-Provides automatic schedule synchronization from config to database.
-"""
-from .apps import DjangoQ2ModuleConfig
-
-__all__ = ['DjangoQ2ModuleConfig']

django_cfg/modules/django_q2/apps.py

@@ -1,107 +0,0 @@
-"""
-AppConfig for Django-Q2 module with automatic schedule synchronization.
-"""
-import logging
-from django.apps import AppConfig
-from django.db.models.signals import post_migrate
-
-logger = logging.getLogger(__name__)
-
-
-def sync_schedules_after_migrate(sender, **kwargs):
-    """
-    Automatically sync Django-Q2 schedules after migrations.
-
-    This ensures schedules are always up-to-date after deployment.
-    Runs only once per migration cycle, safe from race conditions.
-    """
-    # Only run for the django_cfg_django_q2 app itself
-    if sender.name != 'django_cfg.modules.django_q2':
-        return
-
-    # Import here to avoid circular imports and ensure Django is ready
-    try:
-        from django_q.models import Schedule
-        from django_cfg.core.config import get_current_config
-    except ImportError as e:
-        logger.warning(f"Could not import Django-Q2 dependencies: {e}")
-        return
-
-    config = get_current_config()
-
-    if not config or not hasattr(config, 'django_q2') or not config.django_q2 or not config.django_q2.enabled:
-        logger.debug("Django-Q2 not enabled, skipping schedule sync")
-        return
-
-    enabled_schedules = config.django_q2.get_enabled_schedules()
-
-    if not enabled_schedules:
-        logger.debug("No Django-Q2 schedules found in config")
-        return
-
-    logger.info(f"Syncing {len(enabled_schedules)} Django-Q2 schedule(s)...")
-
-    created = 0
-    updated = 0
-
-    for schedule_config in enabled_schedules:
-        schedule_dict = schedule_config.to_django_q_format()
-        name = schedule_dict['name']
-
-        try:
-            schedule, created_flag = Schedule.objects.update_or_create(
-                name=name,
-                defaults=schedule_dict
-            )
-
-            if created_flag:
-                created += 1
-                logger.info(f"  ✓ Created schedule: {name}")
-            else:
-                updated += 1
-                logger.debug(f"  ✓ Updated schedule: {name}")
-
-        except Exception as e:
-            logger.error(f"  ✗ Failed to sync schedule '{name}': {e}")
-
-    logger.info(f"✅ Django-Q2 schedules synced: {created} created, {updated} updated")
-
-
-class DjangoQ2ModuleConfig(AppConfig):
-    """
-    AppConfig for Django-Q2 module.
-
-    Automatically syncs schedules from config to database after migrations.
-    This eliminates the need for manual `sync_django_q_schedules` command.
-
-    Features:
-    - Automatic schedule sync after migrations
-    - Safe from race conditions (runs only once)
-    - Logs all sync operations
-    - Gracefully handles missing dependencies
-
-    Usage:
-        Add to INSTALLED_APPS:
-        INSTALLED_APPS = [
-            ...
-            'django_cfg.modules.django_q2',  # Auto-syncs schedules
-        ]
-    """
-
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'django_cfg.modules.django_q2'
-    verbose_name = 'Django-CFG Django-Q2 Module'
-
-    def ready(self):
-        """
-        Connect post_migrate signal to automatically sync schedules.
-
-        This runs after all migrations are complete, ensuring:
-        1. Database tables exist
-        2. Config is loaded
-        3. Schedules are synced only once per migration cycle
-        """
-        # Connect the signal
-        post_migrate.connect(sync_schedules_after_migrate, sender=self)
-
-        logger.debug(f"{self.verbose_name} initialized - auto-sync enabled")