base-deployment-controller 0.1.0__py3-none-any.whl

base_deployment_controller/__init__.py

@@ -0,0 +1,59 @@
+"""Base Deployment Controller package entry point."""
+from fastapi import FastAPI
+
+from .services.config import ConfigService
+from .routers.environment import EnvRoutes
+from .routers.container import ContainerRoutes
+from .routers.deployment import DeploymentRoutes
+from .builder import AppBuilder
+
+
+def create_app(
+    compose_file: str = "compose.yaml",
+    env_file: str = ".env",
+    include_routers: bool = True,
+    title: str = "Base Deployment Controller",
+    description: str = "REST API to control the basic operations of a deployment",
+    version: str = "1.0.0",
+) -> FastAPI:
+    """
+    Factory function to create a preconfigured FastAPI application.
+
+    Args:
+        compose_file: Path to compose.yaml file.
+        env_file: Path to .env file.
+        include_routers: If True, registers base routers (envs, containers, deployment).
+        title: FastAPI application title.
+        description: FastAPI application description.
+        version: Application version string.
+
+    Returns:
+        FastAPI app ready to use or extend.
+    """
+    app = FastAPI(
+        title=title,
+        description=description,
+        version=version,
+    )
+
+    if include_routers:
+        config_service = ConfigService(compose_file, env_file)
+        env_routes = EnvRoutes(config_service)
+        container_routes = ContainerRoutes(config_service)
+        deployment_routes = DeploymentRoutes(config_service)
+
+        app.include_router(env_routes.router)
+        app.include_router(container_routes.router)
+        app.include_router(deployment_routes.router)
+
+    return app
+
+
+__all__ = [
+    "ConfigService",
+    "EnvRoutes",
+    "ContainerRoutes",
+    "DeploymentRoutes",
+    "AppBuilder",
+    "create_app",
+]

base_deployment_controller/builder.py

@@ -0,0 +1,90 @@
+"""Application builder for composing the FastAPI app and custom routers."""
+from typing import List, Tuple
+
+from fastapi import APIRouter, FastAPI
+
+from .services.config import ConfigService
+from .routers.environment import EnvRoutes
+from .routers.container import ContainerRoutes
+from .routers.deployment import DeploymentRoutes
+
+
+class AppBuilder:
+    """
+    Builder for constructing a Base Deployment Controller FastAPI application.
+
+    Allows registration of custom routers before building the final app.
+
+    Args:
+        compose_file: Path to Docker Compose file.
+        env_file: Path to environment variables file.
+        title: FastAPI application title.
+        description: FastAPI application description.
+        version: Application version string.
+    """
+
+    def __init__(
+        self,
+        compose_file: str = "compose.yaml",
+        env_file: str = ".env",
+        title: str = "Base Deployment Controller",
+        description: str = "REST API for managing base deployment",
+        version: str = "1.0.0",
+    ) -> None:
+        """
+        Initialize the builder and register default routers.
+
+        Args:
+            compose_file: Path to Docker Compose file.
+            env_file: Path to environment variables file.
+            title: FastAPI application title.
+            description: FastAPI application description.
+            version: Application version string.
+        """
+        self.compose_file = compose_file
+        self.env_file = env_file
+        self.title = title
+        self.description = description
+        self.version = version
+        self._custom_routers: List[Tuple[APIRouter, str]] = []
+
+    def register_router(self, router: APIRouter, prefix: str = "") -> "AppBuilder":
+        """
+        Register a custom router to include when building the app.
+
+        Args:
+            router: Router instance to register.
+            prefix: Optional path prefix for the router.
+
+        Returns:
+            AppBuilder instance for fluent chaining.
+        """
+        self._custom_routers.append((router, prefix))
+        return self
+
+    def build(self) -> FastAPI:
+        """
+        Build and return a FastAPI app with base and custom routers.
+
+        Returns:
+            FastAPI application instance.
+        """
+        app = FastAPI(
+            title=self.title,
+            description=self.description,
+            version=self.version,
+        )
+
+        config_service = ConfigService(self.compose_file, self.env_file)
+        env_routes = EnvRoutes(config_service)
+        container_routes = ContainerRoutes(config_service)
+        deployment_routes = DeploymentRoutes(config_service)
+
+        app.include_router(env_routes.router)
+        app.include_router(container_routes.router)
+        app.include_router(deployment_routes.router)
+
+        for router, prefix in self._custom_routers:
+            app.include_router(router, prefix=prefix)
+
+        return app

base_deployment_controller/models/__init__.py

@@ -0,0 +1,33 @@
+"""Pydantic models for the Base Deployment Controller."""
+
+from .environment import (
+    EnvVariable,
+    EnvVariablesResponse,
+    BulkEnvUpdateRequest,
+    EnvUpdateResponse,
+)
+from .container import ContainerInfo, ContainersInfoResponse, ContainerControlResponse
+from .deployment import (
+    DeploymentStatus,
+    DeploymentMetadata,
+    DeploymentInfoResponse,
+    DeploymentPingResponse,
+    DeploymentActionResponse,
+)
+from .compose import ComposeActionResponse
+
+__all__ = [
+    "EnvVariable",
+    "EnvVariablesResponse",
+    "BulkEnvUpdateRequest",
+    "EnvUpdateResponse",
+    "ContainerInfo",
+    "ContainersInfoResponse",
+    "ContainerControlResponse",
+    "DeploymentStatus",
+    "DeploymentMetadata",
+    "DeploymentInfoResponse",
+    "DeploymentPingResponse",
+    "DeploymentActionResponse",
+    "ComposeActionResponse",
+]

base_deployment_controller/models/compose.py

@@ -0,0 +1,11 @@
+"""Docker Compose operation models."""
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class ComposeActionResponse(BaseModel):
+    """Response after executing a docker-compose action (up/stop/restart)."""
+
+    success: bool = Field(..., description="Operation success status")
+    message: str = Field(..., description="Operation result message")

base_deployment_controller/models/container.py

@@ -0,0 +1,31 @@
+"""Container models."""
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+
+class ContainerInfo(BaseModel):
+    """Docker container information and service metadata."""
+
+    name: str = Field(..., description="Container name")
+    image: str = Field(..., description="Container image")
+    status: str = Field(..., description="Container status")
+    started_at: Optional[datetime] = Field(None, description="Container start time")
+    ports: list[str] = Field(..., description="Exposed ports")
+    depends_on: list[str] = Field(..., description="Service dependencies")
+
+
+class ContainersInfoResponse(BaseModel):
+    """Response with list of containers and their current status."""
+
+    containers: list[ContainerInfo] = Field(..., description="List of containers")
+
+
+class ContainerControlResponse(BaseModel):
+    """Response after executing a control action on a container."""
+
+    success: bool = Field(..., description="Action success status")
+    container: str = Field(..., description="Container name")
+    action: str = Field(..., description="Action performed")
+    message: str = Field(..., description="Status message")

base_deployment_controller/models/deployment.py

@@ -0,0 +1,57 @@
+"""Deployment models."""
+from enum import Enum
+
+from .environment import EnvVariable
+from pydantic import BaseModel, Field
+
+
+class DeploymentStatus(str, Enum):
+    """
+    Deployment status enumeration.
+
+    Values:
+        running: All services running.
+        partially_running: Some services running.
+        stopped: No services running.
+        unknown: Status cannot be determined.
+    """
+
+    RUNNING = "running"
+    PARTIALLY_RUNNING = "partially_running"
+    STOPPED = "stopped"
+    UNKNOWN = "unknown"
+
+
+class DeploymentMetadata(BaseModel):
+    """Deployment metadata from x-metadata section in compose.yaml."""
+
+    id: str = Field(..., description="Deployment unique identifier")
+    name: str = Field(..., description="Deployment name")
+    description: str = Field(..., description="Deployment description")
+    version: str = Field(..., description="Deployment version")
+    author: str = Field(..., description="Deployment author")
+    changelog: str = Field(..., description="Deployment changelog")
+    documentation_url: str = Field(..., description="Documentation URL")
+
+
+class DeploymentInfoResponse(BaseModel):
+    """Response with basic deployment information."""
+
+    metadata: DeploymentMetadata = Field(..., description="Deployment metadata")
+    status: DeploymentStatus
+    env_vars: dict[str, EnvVariable] = Field(..., description="List of environment variables")
+
+
+class DeploymentPingResponse(BaseModel):
+    """Response for deployment ping endpoint."""
+
+    success: bool = Field(..., description="Ping success status")
+    message: str = Field(..., description="Ping message")
+
+
+class DeploymentActionResponse(BaseModel):
+    """Response after performing a deployment action."""
+
+    success: bool = Field(..., description="Action success status")
+    action: str = Field(..., description="Action performed")
+    message: str = Field(..., description="Status message")

base_deployment_controller/models/environment.py

@@ -0,0 +1,42 @@
+"""Environment variable models."""
+from pydantic import BaseModel, Field
+
+
+class EnvVariable(BaseModel):
+    """Environment variable model with metadata from x-env-vars schema."""
+
+    name: str = Field(..., description="Variable name")
+    description: str = Field(..., description="Variable description")
+    default: str = Field(..., description="Default value")
+    value: str = Field(..., description="Current value")
+    type: str = Field(..., description="Type constraint")
+    advanced: bool = Field(..., description="Is advanced variable")
+
+
+class EnvVariablesResponse(BaseModel):
+    """Response for listing all environment variables."""
+
+    variables: list[EnvVariable] = Field(..., description="List of environment variables")
+
+
+class BulkEnvUpdateRequest(BaseModel):
+    """Request to update multiple environment variables in bulk."""
+
+    variables: dict[str, str] = Field(..., description="Variables to update")
+    restart_services: bool = Field(
+        default=True,
+        description=(
+            "Whether to restart affected services after updating the variables."
+        ),
+    )
+
+
+class EnvUpdateResponse(BaseModel):
+    """Response after updating environment variables."""
+
+    success: bool = Field(..., description="Update success status")
+    updated: list[str] = Field(..., description="List of updated variables")
+    message: str = Field(..., description="Status message")
+    restarted_services: dict[str, bool] = Field(
+        default_factory=dict, description="Services restarted and their status"
+    )

base_deployment_controller/routers/__init__.py

@@ -0,0 +1,7 @@
+"""FastAPI routers for the Base Deployment Controller."""
+
+from .environment import EnvRoutes
+from .container import ContainerRoutes
+from .deployment import DeploymentRoutes
+
+__all__ = ["EnvRoutes", "ContainerRoutes", "DeploymentRoutes"]