qodalis-cli-server 1.0.0b1__py3-none-any.whl

qodalis_cli/__init__.py

@@ -0,0 +1,112 @@
+"""Qodalis CLI Server - A Python CLI server framework for the Qodalis CLI ecosystem."""
+
+from .abstractions import (
+    ICliCommandAuthor,
+    CliCommandAuthor,
+    DEFAULT_LIBRARY_AUTHOR,
+    CliProcessCommand,
+    ICliCommandParameterDescriptor,
+    CliCommandParameterDescriptor,
+    ICliCommandProcessor,
+    CliCommandProcessor,
+    ICliModule,
+    CliModule,
+)
+from .models import (
+    CliServerOutput,
+    CliServerResponse,
+    CliServerCommandDescriptor,
+    CliServerCommandParameterDescriptorDto,
+)
+from .services import (
+    ICliCommandRegistry,
+    CliCommandRegistry,
+    ICliResponseBuilder,
+    CliResponseBuilder,
+    ICliCommandExecutorService,
+    CliCommandExecutorService,
+    CliEventSocketManager,
+    CliShellSessionManager,
+)
+from .controllers import create_cli_router, create_cli_router_v2, create_cli_version_router, create_filesystem_router
+from .extensions import CliBuilder
+from .filesystem import FileSystemOptions, FileSystemPathValidator
+
+# Re-export filesystem plugin types for convenience
+from qodalis_cli_filesystem import (
+    FileEntry,
+    FileStat,
+    FileStorageExistsError,
+    FileStorageIsADirectoryError,
+    FileStorageNotADirectoryError,
+    FileStorageNotFoundError,
+    FileStoragePermissionError,
+    IFileStorageProvider,
+)
+from qodalis_cli_filesystem.providers import (
+    InMemoryFileStorageProvider,
+    OsFileStorageProvider,
+    OsProviderOptions,
+)
+from .processors import (
+    CliEchoCommandProcessor,
+    CliStatusCommandProcessor,
+    CliSystemCommandProcessor,
+    CliHttpCommandProcessor,
+    CliHashCommandProcessor,
+    CliBase64CommandProcessor,
+    CliUuidCommandProcessor,
+)
+from .create_cli_server import create_cli_server, CliServerOptions
+
+__all__ = [
+    "ICliCommandAuthor",
+    "CliCommandAuthor",
+    "DEFAULT_LIBRARY_AUTHOR",
+    "CliProcessCommand",
+    "ICliCommandParameterDescriptor",
+    "CliCommandParameterDescriptor",
+    "ICliCommandProcessor",
+    "CliCommandProcessor",
+    "ICliModule",
+    "CliModule",
+    "CliServerOutput",
+    "CliServerResponse",
+    "CliServerCommandDescriptor",
+    "CliServerCommandParameterDescriptorDto",
+    "ICliCommandRegistry",
+    "CliCommandRegistry",
+    "ICliResponseBuilder",
+    "CliResponseBuilder",
+    "ICliCommandExecutorService",
+    "CliCommandExecutorService",
+    "CliEventSocketManager",
+    "CliShellSessionManager",
+    "create_cli_router",
+    "create_cli_router_v2",
+    "create_cli_version_router",
+    "create_filesystem_router",
+    "CliBuilder",
+    "FileSystemOptions",
+    "FileSystemPathValidator",
+    "CliEchoCommandProcessor",
+    "CliStatusCommandProcessor",
+    "CliSystemCommandProcessor",
+    "CliHttpCommandProcessor",
+    "CliHashCommandProcessor",
+    "CliBase64CommandProcessor",
+    "CliUuidCommandProcessor",
+    "create_cli_server",
+    "CliServerOptions",
+    "FileEntry",
+    "FileStat",
+    "FileStorageExistsError",
+    "FileStorageIsADirectoryError",
+    "FileStorageNotADirectoryError",
+    "FileStorageNotFoundError",
+    "FileStoragePermissionError",
+    "IFileStorageProvider",
+    "InMemoryFileStorageProvider",
+    "OsFileStorageProvider",
+    "OsProviderOptions",
+]

qodalis_cli/abstractions/__init__.py

@@ -0,0 +1,25 @@
+from qodalis_cli_server_abstractions import (
+    ICliCommandAuthor,
+    CliCommandAuthor,
+    DEFAULT_LIBRARY_AUTHOR,
+    CliProcessCommand,
+    ICliCommandParameterDescriptor,
+    CliCommandParameterDescriptor,
+    ICliCommandProcessor,
+    CliCommandProcessor,
+    ICliModule,
+    CliModule,
+)
+
+__all__ = [
+    "ICliCommandAuthor",
+    "CliCommandAuthor",
+    "DEFAULT_LIBRARY_AUTHOR",
+    "CliProcessCommand",
+    "ICliCommandParameterDescriptor",
+    "CliCommandParameterDescriptor",
+    "ICliCommandProcessor",
+    "CliCommandProcessor",
+    "ICliModule",
+    "CliModule",
+]

qodalis_cli/abstractions/cli_command_author.py

@@ -0,0 +1,7 @@
+from qodalis_cli_server_abstractions.cli_command_author import (
+    ICliCommandAuthor,
+    CliCommandAuthor,
+    DEFAULT_LIBRARY_AUTHOR,
+)
+
+__all__ = ["ICliCommandAuthor", "CliCommandAuthor", "DEFAULT_LIBRARY_AUTHOR"]

qodalis_cli/abstractions/cli_command_parameter_descriptor.py

@@ -0,0 +1,6 @@
+from qodalis_cli_server_abstractions.cli_command_parameter_descriptor import (
+    ICliCommandParameterDescriptor,
+    CliCommandParameterDescriptor,
+)
+
+__all__ = ["ICliCommandParameterDescriptor", "CliCommandParameterDescriptor"]

qodalis_cli/abstractions/cli_command_processor.py

@@ -0,0 +1,6 @@
+from qodalis_cli_server_abstractions.cli_command_processor import (
+    ICliCommandProcessor,
+    CliCommandProcessor,
+)
+
+__all__ = ["ICliCommandProcessor", "CliCommandProcessor"]

qodalis_cli/abstractions/cli_process_command.py

@@ -0,0 +1,3 @@
+from qodalis_cli_server_abstractions.cli_process_command import CliProcessCommand
+
+__all__ = ["CliProcessCommand"]

qodalis_cli/controllers/__init__.py

@@ -0,0 +1,11 @@
+from .cli_controller import create_cli_router
+from .cli_controller_v2 import create_cli_router_v2
+from .cli_version_controller import create_cli_version_router
+from .filesystem_controller import create_filesystem_router
+
+__all__ = [
+    "create_cli_router",
+    "create_cli_router_v2",
+    "create_cli_version_router",
+    "create_filesystem_router",
+]

qodalis_cli/controllers/cli_controller.py

@@ -0,0 +1,111 @@
+from __future__ import annotations
+
+import platform
+from typing import Any
+
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from pydantic import BaseModel, Field
+
+from ..abstractions import ICliCommandProcessor
+from ..abstractions.cli_process_command import CliProcessCommand
+from ..models import CliServerCommandDescriptor, CliServerCommandParameterDescriptorDto, CliServerResponse
+from ..services.cli_command_executor_service import ICliCommandExecutorService
+from ..services.cli_command_registry import ICliCommandRegistry
+
+SERVER_VERSION = "1.0.0"
+
+
+class ExecuteRequest(BaseModel):
+    command: str = ""
+    raw_command: str = Field(alias="rawCommand", default="")
+    value: str | None = None
+    args: dict[str, Any] = Field(default_factory=dict)
+    chain_commands: list[str] = Field(alias="chainCommands", default_factory=list)
+    data: Any = None
+
+    model_config = {"populate_by_name": True}
+
+
+def _map_to_descriptor(processor: ICliCommandProcessor) -> dict[str, Any]:
+    params = None
+    if processor.parameters:
+        params = [
+            CliServerCommandParameterDescriptorDto(
+                name=p.name,
+                description=p.description,
+                required=p.required,
+                type=p.type,
+                aliases=p.aliases,
+                defaultValue=p.default_value,
+            ).model_dump(by_alias=True, exclude_none=True)
+            for p in processor.parameters
+        ]
+
+    subs = None
+    if processor.processors:
+        subs = [_map_to_descriptor(p) for p in processor.processors]
+
+    desc = CliServerCommandDescriptor(
+        command=processor.command,
+        description=processor.description,
+        version=processor.version,
+        parameters=params if params else None,
+        processors=subs if subs else None,
+        allowUnlistedCommands=processor.allow_unlisted_commands,
+        valueRequired=processor.value_required,
+        author={"name": processor.author.name, "email": processor.author.email},
+    )
+    return desc.model_dump(by_alias=True, exclude_none=True)
+
+
+def create_cli_router(
+    registry: ICliCommandRegistry,
+    executor: ICliCommandExecutorService,
+) -> APIRouter:
+    router = APIRouter()
+
+    @router.get("/version")
+    async def get_version() -> dict[str, str]:
+        return {"version": SERVER_VERSION}
+
+    @router.get("/capabilities")
+    async def get_capabilities() -> dict[str, Any]:
+        detected_os = (
+            "darwin" if platform.system() == "Darwin"
+            else "win32" if platform.system() == "Windows"
+            else "linux"
+        )
+
+        shell = "powershell" if platform.system() == "Windows" else "bash"
+        shell_path = (
+            "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
+            if platform.system() == "Windows"
+            else "/bin/bash"
+        )
+
+        return {
+            "shell": True,
+            "os": detected_os,
+            "shellPath": shell_path,
+            "version": SERVER_VERSION,
+        }
+
+    @router.get("/commands")
+    async def get_commands() -> list[dict[str, Any]]:
+        return [_map_to_descriptor(p) for p in registry.processors]
+
+    @router.post("/execute")
+    async def execute_command(request: ExecuteRequest) -> JSONResponse:
+        cmd = CliProcessCommand(
+            command=request.command,
+            raw_command=request.raw_command,
+            value=request.value,
+            args=request.args,
+            chain_commands=request.chain_commands,
+            data=request.data,
+        )
+        result = await executor.execute_async(cmd)
+        return JSONResponse(result.model_dump(by_alias=True, exclude_none=True))
+
+    return router

qodalis_cli/controllers/cli_controller_v2.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from typing import Any
+
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from pydantic import BaseModel, Field
+
+from ..abstractions import ICliCommandProcessor
+from ..abstractions.cli_process_command import CliProcessCommand
+from ..models import CliServerCommandDescriptor, CliServerCommandParameterDescriptorDto, CliServerResponse
+from ..services.cli_command_executor_service import ICliCommandExecutorService
+from ..services.cli_command_registry import ICliCommandRegistry
+
+
+class ExecuteRequestV2(BaseModel):
+    command: str = ""
+    raw_command: str = Field(alias="rawCommand", default="")
+    value: str | None = None
+    args: dict[str, Any] = Field(default_factory=dict)
+    chain_commands: list[str] = Field(alias="chainCommands", default_factory=list)
+    data: Any = None
+
+    model_config = {"populate_by_name": True}
+
+
+def _map_to_descriptor_v2(processor: ICliCommandProcessor) -> dict[str, Any]:
+    params = None
+    if processor.parameters:
+        params = [
+            CliServerCommandParameterDescriptorDto(
+                name=p.name,
+                description=p.description,
+                required=p.required,
+                type=p.type,
+                aliases=p.aliases,
+                defaultValue=p.default_value,
+            ).model_dump(by_alias=True, exclude_none=True)
+            for p in processor.parameters
+        ]
+
+    subs = None
+    if processor.processors:
+        subs = [_map_to_descriptor_v2(p) for p in processor.processors]
+
+    desc = CliServerCommandDescriptor(
+        command=processor.command,
+        description=processor.description,
+        version=processor.version,
+        apiVersion=processor.api_version,
+        parameters=params if params else None,
+        processors=subs if subs else None,
+        allowUnlistedCommands=processor.allow_unlisted_commands,
+        valueRequired=processor.value_required,
+        author={"name": processor.author.name, "email": processor.author.email},
+    )
+    return desc.model_dump(by_alias=True, exclude_none=True)
+
+
+def create_cli_router_v2(
+    registry: ICliCommandRegistry,
+    executor: ICliCommandExecutorService,
+) -> APIRouter:
+    router = APIRouter()
+
+    @router.get("/version")
+    async def get_version_v2() -> dict[str, Any]:
+        return {"apiVersion": 2, "serverVersion": "2.0.0"}
+
+    @router.get("/commands")
+    async def get_commands_v2() -> list[dict[str, Any]]:
+        return [
+            _map_to_descriptor_v2(p)
+            for p in registry.processors
+            if p.api_version >= 2
+        ]
+
+    @router.post("/execute")
+    async def execute_command_v2(request: ExecuteRequestV2) -> JSONResponse:
+        cmd = CliProcessCommand(
+            command=request.command,
+            raw_command=request.raw_command,
+            value=request.value,
+            args=request.args,
+            chain_commands=request.chain_commands,
+            data=request.data,
+        )
+        result = await executor.execute_async(cmd)
+        return JSONResponse(result.model_dump(by_alias=True, exclude_none=True))
+
+    return router

qodalis_cli/controllers/cli_version_controller.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import os
+import platform
+from typing import Any
+
+from fastapi import APIRouter
+
+SERVER_VERSION = "1.0.0"
+
+
+def create_cli_version_router() -> APIRouter:
+    router = APIRouter()
+
+    @router.get("/versions")
+    async def get_versions() -> dict[str, Any]:
+        return {
+            "supportedVersions": [1, 2],
+            "preferredVersion": 2,
+            "serverVersion": SERVER_VERSION,
+        }
+
+    @router.get("/capabilities")
+    async def get_capabilities() -> dict[str, Any]:
+        detected_os = (
+            "darwin" if platform.system() == "Darwin"
+            else "win32" if platform.system() == "Windows"
+            else "linux"
+        )
+
+        shell = "powershell" if platform.system() == "Windows" else "bash"
+        shell_path = (
+            "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
+            if platform.system() == "Windows"
+            else "/bin/bash"
+        )
+
+        return {
+            "shell": True,
+            "os": detected_os,
+            "shellPath": shell_path,
+            "version": SERVER_VERSION,
+        }
+
+    return router