hexastack-cli 0.4.0__tar.gz → 0.6.0__tar.gz

{hexastack_cli-0.4.0 → hexastack_cli-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexastack-cli
-Version: 0.4.0
+Version: 0.6.0
 Summary: Hexastack CLI presentation adapter with Typer and Rich
 Author: Richard West
 Author-email: Richard West <dopplereffect.us@gmail.com>

{hexastack_cli-0.4.0 → hexastack_cli-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.4.0"
+version = "0.6.0"
 description = "Hexastack CLI presentation adapter with Typer and Rich"
 readme = "README.md"
 license = "Apache-2.0"

{hexastack_cli-0.4.0 → hexastack_cli-0.6.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.4.0"
+version = "0.6.0"
 description = "Hexastack CLI presentation adapter with Typer and Rich"
 readme = "README.md"
 license = "Apache-2.0"

hexastack_cli-0.6.0/src/hexastack_cli/__init__.py

@@ -0,0 +1,12 @@
+from hexastack_cli import adapters, domain, infra
+from hexastack_cli.domain.options import OutputFormat
+from hexastack_cli.infra.options import format_option, resolve_format
+
+__all__ = [
+    "adapters",
+    "domain",
+    "format_option",
+    "infra",
+    "OutputFormat",
+    "resolve_format",
+]

{hexastack_cli-0.4.0 → hexastack_cli-0.6.0}/src/hexastack_cli/adapters/presenter.py

@@ -8,6 +8,7 @@ from rich.console import Console
 from rich.panel import Panel
 from rich.table import Table
 
+from hexastack_cli.domain.options import OutputFormat
 from hexastack_core.domain import Generic
 from hexastack_core.ports.presenter import PresenterPort
 
@@ -79,16 +80,33 @@ class RichTerminalPresenter(PresenterPort):
             self._console.print(f"[bold green]{data}[/bold green]")
         return data
 
+    def _present_markdown(self, instance: Generic, data: Any) -> Any:
+        """Render markdown formatted representation to stdout."""
+        if isinstance(data, dict):
+            title = type(instance).__name__
+            lines = [f"### {title}", "", "| Field | Value |", "|---|---|"]
+            for k, v in data.items():
+                val_str = json.dumps(v) if isinstance(v, dict | list) else str(v)
+                lines.append(f"| {k} | {val_str} |")
+            sys.stdout.write("\n".join(lines) + "\n")
+        elif isinstance(data, list):
+            lines = [f"- {item}" for item in data]
+            sys.stdout.write("\n".join(lines) + "\n")
+        else:
+            sys.stdout.write(f"**{data}**\n")
+        sys.stdout.flush()
+        return data
+
     def present(
         self,
         instance: Generic,
-        format_mode: str | None = None,
+        format_mode: str | OutputFormat | None = None,
     ) -> Any:
         """Format and print a domain Generic instance to stdout based on requested format mode.
 
         Args:
             instance: Domain Generic or DTO model instance.
-            format_mode: Optional format mode ('table', 'json', 'plain').
+            format_mode: Optional format mode ('table', 'json', 'plain', 'markdown').
 
         Returns:
             The presented raw data representation.
@@ -98,12 +116,17 @@ class RichTerminalPresenter(PresenterPort):
         """
         data = instance.model_dump() if isinstance(instance, BaseModel) else instance
 
-        mode = (format_mode or "table").lower()
+        if isinstance(format_mode, OutputFormat):
+            mode = format_mode.value
+        else:
+            mode = (format_mode or OutputFormat.TABLE.value).lower().strip()
 
-        if mode == "json":
+        if mode == OutputFormat.JSON.value:
             return self._present_json(data)
-        if mode == "plain":
+        if mode == OutputFormat.PLAIN.value:
             return self._present_plain(data)
+        if mode == OutputFormat.MARKDOWN.value:
+            return self._present_markdown(instance, data)
         return self._present_table(instance, data)
 
     def print_error(self, message: str) -> None:

hexastack_cli-0.6.0/src/hexastack_cli/domain/__init__.py

@@ -0,0 +1,11 @@
+"""Domain models and enumerations for Hexastack CLI."""
+
+from __future__ import annotations
+
+from hexastack_cli.domain.config import HexastackCliConfig
+from hexastack_cli.domain.options import OutputFormat
+
+__all__ = [
+    "HexastackCliConfig",
+    "OutputFormat",
+]

hexastack_cli-0.6.0/src/hexastack_cli/domain/options.py

@@ -0,0 +1,25 @@
+"""Domain representations for CLI output presentation formats.
+
+Notes/Architectural Intent:
+    Defines the canonical output format enumeration shared across CLI presenters,
+    command runners, and reporting bridges. Fulfills the cross-ecosystem CLI alignment invariant.
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+__all__ = [
+    "OutputFormat",
+]
+
+
+class OutputFormat(StrEnum):
+    """Supported output presentation formats for CLI commands."""
+
+    AUTO = "auto"
+    JSON = "json"
+    MARKDOWN = "markdown"
+    PLAIN = "plain"
+    RICH = "rich"
+    TABLE = "table"

{hexastack_cli-0.4.0 → hexastack_cli-0.6.0}/src/hexastack_cli/infra/__init__.py

@@ -15,6 +15,10 @@ from hexastack_cli.infra.decorators import (
     cli_group,
     cli_query,
 )
+from hexastack_cli.infra.options import (
+    format_option,
+    resolve_format,
+)
 
 __all__ = [
     "autodiscover_cli_commands",
@@ -25,7 +29,9 @@ __all__ = [
     "CliMetadata",
     "create_cli_app",
     "create_cli_visitor",
+    "format_option",
     "GroupMetadata",
     "HexastackCliConfig",
     "register_cli_config",
+    "resolve_format",
 ]

hexastack_cli-0.6.0/src/hexastack_cli/infra/options.py

@@ -0,0 +1,73 @@
+"""CLI option factories and formatting resolvers for Hexastack CLI applications.
+
+Notes/Architectural Intent:
+    Provides standardized Typer option factories and stdout pipe-detection routines.
+    When format is 'auto', automatically routes to structured JSON when piped into
+    downstream Unix utilities (jq, grep) or styled Rich/table output when attached to an
+    interactive TTY. Aligns with the Hexa ecosystem CLI standards.
+"""
+
+from __future__ import annotations
+
+import sys
+from enum import Enum
+from typing import Any
+
+import typer
+
+from hexastack_cli.domain.options import OutputFormat
+
+__all__ = [
+    "format_option",
+    "resolve_format",
+]
+
+
+def resolve_format(
+    format_type: str | OutputFormat,
+    default_tty: str = "table",
+    default_pipe: str = "json",
+) -> str:
+    """Resolve an output format string, handling auto-detection for pipes.
+
+    Args:
+        format_type: The format chosen by user or default ('auto', 'table', 'json', etc.).
+        default_tty: Default format when connected to an interactive terminal.
+        default_pipe: Default format when stdout is piped or redirected.
+
+    Returns:
+        Normalized lowercase format string (e.g. 'table', 'json', 'rich').
+
+    Notes/Architectural Intent:
+        When format_type is 'auto', inspects sys.stdout.isatty() to choose between
+        structured machine-readable format for pipelines or visual format for humans.
+    """
+    raw = (
+        format_type.value
+        if isinstance(format_type, Enum)
+        else str(format_type).lower().strip()
+    )
+    if raw == OutputFormat.AUTO.value:
+        if not sys.stdout.isatty():
+            return default_pipe
+        return default_tty
+    return raw
+
+
+def format_option(
+    default: str = "table",
+    help_text: str = "Output presentation format (table, json, markdown, rich, plain, auto).",
+) -> Any:
+    """Construct a standardized Typer option for format selection.
+
+    Args:
+        default: Default format option value.
+        help_text: Help string to render in CLI usage catalogs.
+
+    Returns:
+        Configured Typer Option specification.
+
+    Notes/Architectural Intent:
+        Standardizes '-f' / '--format' flag across all Hexastack CLI commands.
+    """
+    return typer.Option(default, "-f", "--format", help=help_text)

hexastack_cli-0.4.0/src/hexastack_cli/__init__.py

@@ -1,6 +0,0 @@
-from hexastack_cli import adapters, infra
-
-__all__ = [
-    "adapters",
-    "infra",
-]