aegis-stack 0.2.0rc2__py3-none-any.whl

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/app/services/system/models.py

@@ -0,0 +1,243 @@
+"""
+System domain Pydantic models.
+
+Type-safe data models for system health monitoring, alerts, and status reporting.
+All models provide runtime validation and automatic FastAPI integration.
+"""
+
+from datetime import datetime
+from enum import Enum
+from typing import Any
+
+from pydantic import BaseModel, Field, computed_field
+
+
+class ComponentStatusType(str, Enum):
+    """Component status levels."""
+
+    HEALTHY = "healthy"
+    INFO = "info"
+    WARNING = "warning"
+    UNHEALTHY = "unhealthy"
+
+
+class ComponentStatus(BaseModel):
+    """Status of a single system component."""
+
+    name: str = Field(..., description="Component name")
+    status: ComponentStatusType = Field(
+        default=ComponentStatusType.HEALTHY,
+        description="Detailed status level (healthy/info/warning/unhealthy)",
+    )
+    message: str = Field(..., description="Status message or error description")
+    response_time_ms: float | None = Field(
+        None, description="Response time in milliseconds"
+    )
+    metadata: dict[str, Any] = Field(
+        default_factory=dict, description="Additional component metadata"
+    )
+    sub_components: dict[str, "ComponentStatus"] = Field(
+        default_factory=dict,
+        description="Sub-components (e.g., system metrics under backend)",
+    )
+
+    @computed_field  # type: ignore[prop-decorator]
+    @property
+    def healthy(self) -> bool:
+        """
+        Component is healthy if status is not UNHEALTHY.
+
+        WARNING and INFO statuses are considered healthy (functional but with concerns),
+        only UNHEALTHY is considered not healthy (non-functional).
+        """
+        return self.status != ComponentStatusType.UNHEALTHY
+
+
+class SystemStatus(BaseModel):
+    """Overall system status with component details."""
+
+    components: dict[str, ComponentStatus] = Field(
+        ..., description="Component status by name"
+    )
+    overall_healthy: bool = Field(..., description="Whether all components are healthy")
+    timestamp: datetime = Field(..., description="When status was generated")
+    system_info: dict[str, Any] = Field(
+        default_factory=dict, description="System information"
+    )
+
+    def _get_all_components_flat(self) -> list[tuple[str, ComponentStatus]]:
+        """Get all components including sub-components as a flat list."""
+        all_components = []
+
+        for name, component in self.components.items():
+            all_components.extend(self._flatten_component(name, component))
+
+        return all_components
+
+    def _flatten_component(
+        self, name: str, component: ComponentStatus
+    ) -> list[tuple[str, ComponentStatus]]:
+        """Recursively flatten a component and its sub-components into a list."""
+        result = [(name, component)]
+        # Recursively add sub-components with parent.child naming
+        for sub_name, sub_component in component.sub_components.items():
+            result.extend(self._flatten_component(f"{name}.{sub_name}", sub_component))
+        return result
+
+    @property
+    def healthy_components(self) -> list[str]:
+        """List of healthy component names (including sub-components)."""
+        return [
+            name
+            for name, component in self._get_all_components_flat()
+            if component.healthy
+        ]
+
+    @property
+    def unhealthy_components(self) -> list[str]:
+        """List of unhealthy component names (including sub-components)."""
+        return [
+            name
+            for name, component in self._get_all_components_flat()
+            if not component.healthy
+        ]
+
+    @property
+    def health_percentage(self) -> float:
+        """Percentage of healthy components (including sub-components)."""
+        all_components = self._get_all_components_flat()
+        if not all_components:
+            return 100.0
+        healthy_count = len([c for _, c in all_components if c.healthy])
+        return (healthy_count / len(all_components)) * 100
+
+    @property
+    def total_components(self) -> int:
+        """Total number of top-level components."""
+        return len(self.components)
+
+    @property
+    def healthy_top_level_components(self) -> list[str]:
+        """List of healthy top-level component names."""
+        return [name for name, comp in self.components.items() if comp.healthy]
+
+    @property
+    def services_status(self) -> ComponentStatus | None:
+        """Get the services component status if it exists."""
+        if "aegis" in self.components:
+            aegis_component = self.components["aegis"]
+            if (
+                hasattr(aegis_component, "sub_components")
+                and aegis_component.sub_components
+            ):
+                return aegis_component.sub_components.get("services")
+        return None
+
+    @property
+    def has_services(self) -> bool:
+        """Check if any services are registered in the system."""
+        return self.services_status is not None
+
+    @property
+    def service_names(self) -> list[str]:
+        """Get list of registered service names."""
+        services_component = self.services_status
+        if services_component and hasattr(services_component, "sub_components"):
+            return list(services_component.sub_components.keys())
+        return []
+
+    @property
+    def healthy_services(self) -> list[str]:
+        """List of healthy service names."""
+        services_component = self.services_status
+        if services_component and hasattr(services_component, "sub_components"):
+            return [
+                name
+                for name, service in services_component.sub_components.items()
+                if service.healthy
+            ]
+        return []
+
+    @property
+    def unhealthy_services(self) -> list[str]:
+        """List of unhealthy service names."""
+        services_component = self.services_status
+        if services_component and hasattr(services_component, "sub_components"):
+            return [
+                name
+                for name, service in services_component.sub_components.items()
+                if not service.healthy
+            ]
+        return []
+
+
+class HealthResponse(BaseModel):
+    """Basic health check API response."""
+
+    healthy: bool = Field(..., description="Whether system is healthy")
+    status: str = Field(..., description="Overall status text")
+    components: dict[str, ComponentStatus] = Field(
+        default_factory=dict, description="Component statuses"
+    )
+    timestamp: str = Field(..., description="ISO timestamp when checked")
+
+
+class DetailedHealthResponse(BaseModel):
+    """Detailed health check API response with system information."""
+
+    healthy: bool = Field(..., description="Whether system is healthy")
+    status: str = Field(..., description="Overall status text")
+    service: str = Field(..., description="Service name")
+    version: str = Field(..., description="Service version")
+    components: dict[str, ComponentStatus] = Field(
+        ..., description="Component statuses"
+    )
+    system_info: dict[str, Any] = Field(..., description="System information")
+    timestamp: str = Field(..., description="ISO timestamp when checked")
+    healthy_components: list[str] = Field(
+        ..., description="List of healthy component names"
+    )
+    unhealthy_components: list[str] = Field(
+        ..., description="List of unhealthy component names"
+    )
+    health_percentage: float = Field(
+        ..., description="Percentage of healthy components"
+    )
+    # Service-specific fields (optional)
+    has_services: bool = Field(
+        default=False, description="Whether any services are registered"
+    )
+    service_names: list[str] = Field(
+        default_factory=list, description="List of registered service names"
+    )
+    healthy_services: list[str] = Field(
+        default_factory=list, description="List of healthy service names"
+    )
+    unhealthy_services: list[str] = Field(
+        default_factory=list, description="List of unhealthy service names"
+    )
+
+
+class AlertSeverity(BaseModel):
+    """Alert severity levels as constants."""
+
+    INFO: str = Field(default="info", description="Informational alert")
+    WARNING: str = Field(default="warning", description="Warning alert")
+    ERROR: str = Field(default="error", description="Error alert")
+    CRITICAL: str = Field(default="critical", description="Critical alert")
+
+
+class Alert(BaseModel):
+    """System alert model."""
+
+    severity: str = Field(..., description="Alert severity level")
+    title: str = Field(..., min_length=1, description="Alert title")
+    message: str = Field(..., min_length=1, description="Alert message")
+    timestamp: datetime = Field(..., description="When alert was created")
+    metadata: dict[str, Any] = Field(
+        default_factory=dict, description="Additional alert data"
+    )
+
+
+# Singleton for alert severity constants
+alert_severity = AlertSeverity()

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/app/services/system/ui.py

@@ -0,0 +1,52 @@
+"""
+Shared UI helpers for status presentation across CLI and frontend.
+
+Provides a single source of truth for mapping ComponentStatusType to
+icons and semantic colors, so CLI and dashboard remain consistent.
+"""
+
+from .models import ComponentStatusType
+
+
+def get_status_icon(status: ComponentStatusType) -> str:
+    """Return the display icon for a given status.
+
+    Note: INFO icon intentionally includes a trailing space for terminal alignment.
+    """
+    if status == ComponentStatusType.HEALTHY:
+        return "✅"
+    if status == ComponentStatusType.INFO:
+        return "ℹ️ "
+    if status == ComponentStatusType.WARNING:
+        return "⚠️"
+    if status == ComponentStatusType.UNHEALTHY:
+        return "❌"
+    return "❓"
+
+
+def get_status_color_name(status: ComponentStatusType) -> str:
+    """Return a semantic color name for a given status (CLI friendly).
+
+    Frontend can adapt these semantic names to theme-specific colors.
+    """
+    if status == ComponentStatusType.HEALTHY:
+        return "green"
+    if status == ComponentStatusType.INFO:
+        return "blue"
+    if status == ComponentStatusType.WARNING:
+        return "yellow"
+    if status == ComponentStatusType.UNHEALTHY:
+        return "red"
+    return "white"
+
+
+def get_component_label(component_name: str) -> str:
+    """Map component keys to user-facing labels (brand or friendly name)."""
+    mapping = {
+        "backend": "FastAPI",
+        "frontend": "Flet",
+        "cache": "Redis",
+        "worker": "arq",
+        "scheduler": "APScheduler",
+    }
+    return mapping.get(component_name, component_name.title())

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/clean-validation/.dockerignore

@@ -0,0 +1,71 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments - don't mount host venv into container
+.venv/
+.env/
+venv/
+ENV/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs
+*.log
+
+# Temporary files
+*.tmp
+*.temp
+
+# Git
+.git/
+.gitignore
+
+# Documentation build
+site/
+docs/_build/
+
+# Cache
+.cache/
+.mypy_cache/
+.ruff_cache/

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/clean-validation/.env.example.j2

@@ -0,0 +1,64 @@
+# Aegis Stack Environment Variables Example
+# Copy this file to .env and customize for your environment
+
+# =============================================================================
+# APPLICATION SETTINGS
+# =============================================================================
+
+# Environment: dev, qa, stg, prod
+APP_ENV=dev
+
+# Port to run the webserver on
+PORT=8000
+
+# Logging level: DEBUG, INFO, WARNING, ERROR
+LOG_LEVEL=INFO
+
+# Auto-reload server on code changes (development only)
+AUTO_RELOAD=true
+
+# =============================================================================
+# DOCKER SETTINGS
+# =============================================================================
+
+# Docker image tag (used by docker-compose)
+AEGIS_STACK_TAG=aegis-stack:latest
+
+# Version tag for builds
+AEGIS_STACK_VERSION=dev
+
+# Environment file to use (defaults to .env)
+# AEGIS_STACK_ENV_FILE=.env
+
+# =============================================================================
+# COMPONENT SETTINGS
+# =============================================================================
+
+
+# Database settings
+# DATABASE_URL=sqlite:///./data/app.db  # SQLite database (default)
+# DATABASE_ENGINE_ECHO=false  # Set to true to log all SQL queries (debugging)
+
+
+
+
+
+# Scheduler settings
+# SCHEDULER_TIMEZONE=UTC
+# SCHEDULER_MAX_WORKERS=10
+
+
+# API Keys and Secrets (add as needed)
+# SECRET_KEY=your-super-secret-key-here
+# API_KEY=your-api-key-here
+
+# =============================================================================
+# DEVELOPMENT OVERRIDES
+# =============================================================================
+
+# Worker auto-reload settings
+# WORKER_WATCH=false  # Disable worker auto-reload (useful for debugging)
+
+# Override for local development
+# Use this to point to local services instead of Docker services
+# DATABASE_HOST=host.docker.internal  # For connecting to host DB from container

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/clean-validation/.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*.so
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Database files and data directory
+data/
+*.db
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

aegis/templates/cookiecutter-aegis-project/{{cookiecutter.project_slug}}/clean-validation/Dockerfile

@@ -0,0 +1,53 @@
+FROM python:3.11-slim
+
+# Install system dependencies and clean up
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends \
+      build-essential \
+      ca-certificates \
+      curl \
+    && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Install uv with specific version for reproducibility
+RUN pip install --no-cache-dir uv==0.4.18
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONPATH=/code \
+    UV_CACHE_DIR=/tmp/uv-cache
+
+WORKDIR /code
+
+# Copy dependency files and README (needed by pyproject.toml)
+COPY pyproject.toml uv.lock README.md /code/
+
+# Install dependencies
+RUN uv sync --all-extras && \
+    rm -rf /tmp/uv-cache
+
+# Copy application code
+COPY . /code
+
+# Make entrypoint executable
+RUN chmod +x /code/scripts/entrypoint.sh
+
+# Set default port as an environment variable
+ARG PORT=8000
+ENV PORT=$PORT
+
+# Expose the port
+EXPOSE $PORT
+
+# Add health check
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+  CMD curl -f http://localhost:$PORT/health || exit 1
+
+
+# Labels for better container management
+LABEL maintainer="contact@aegis-stack.dev" \
+      version="0.1.0" \
+      description="Aegis Stack - Production-ready async Python foundation"
+
+ENTRYPOINT ["uv", "run", "/code/scripts/entrypoint.sh"]