@pennyfarthing/core 7.8.0 → 7.8.2

package/pennyfarthing_scripts/common/__init__.py

@@ -0,0 +1,49 @@
+"""Common utilities for Pennyfarthing scripts.
+
+This package provides shared utilities used across all CLI tools:
+- output: Colored console output functions
+- config: Project configuration loading
+"""
+
+from pennyfarthing_scripts.common.output import (
+    Colors,
+    bold,
+    debug,
+    dim,
+    divider,
+    error,
+    header,
+    info,
+    success,
+    warn,
+    _colorize,
+    _supports_color,
+)
+
+from pennyfarthing_scripts.common.config import (
+    find_project_root,
+    get_project_root,
+    load_pennyfarthing_config,
+    load_yaml_config,
+)
+
+__all__ = [
+    # Output
+    "Colors",
+    "bold",
+    "debug",
+    "dim",
+    "divider",
+    "error",
+    "header",
+    "info",
+    "success",
+    "warn",
+    "_colorize",
+    "_supports_color",
+    # Config
+    "find_project_root",
+    "get_project_root",
+    "load_pennyfarthing_config",
+    "load_yaml_config",
+]

package/pennyfarthing_scripts/common/config.py

@@ -0,0 +1,65 @@
+"""
+Configuration loading utilities for Pennyfarthing scripts.
+
+Provides YAML config loading with graceful degradation for missing files.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+
+def get_project_root(start_dir: Path | None = None) -> Path:
+    """Find the Pennyfarthing project root.
+
+    Walks up from start_dir (or cwd) looking for .pennyfarthing directory.
+
+    Args:
+        start_dir: Directory to start search from (defaults to cwd)
+
+    Returns:
+        Path to project root directory
+
+    Raises:
+        FileNotFoundError: If no .pennyfarthing directory found
+    """
+    current = Path(start_dir) if start_dir else Path.cwd()
+    current = current.resolve()
+
+    while current != current.parent:
+        if (current / ".pennyfarthing").is_dir():
+            return current
+        current = current.parent
+
+    raise FileNotFoundError("Could not find project root (no .pennyfarthing/ directory found)")
+
+
+# Alias for backwards compatibility
+find_project_root = get_project_root
+
+
+def load_yaml_config(path: Path) -> dict[str, Any] | None:
+    """Load a YAML configuration file.
+
+    Args:
+        path: Path to the YAML file
+
+    Returns:
+        Parsed YAML as dict, or None if file doesn't exist
+    """
+    if not path.exists():
+        return None
+
+    with open(path, "r") as f:
+        return yaml.safe_load(f)
+
+
+def load_pennyfarthing_config() -> dict[str, Any]:
+    """Load .pennyfarthing/config.local.yaml.
+
+    Returns:
+        Config dict, or empty dict if not found
+    """
+    config_path = get_project_root() / ".pennyfarthing" / "config.local.yaml"
+    return load_yaml_config(config_path) or {}

package/pennyfarthing_scripts/common/output.py

@@ -0,0 +1,180 @@
+"""
+Console output utilities for Pennyfarthing scripts.
+
+Provides consistent colored output for CLI tools:
+- success(): Green [OK] prefix
+- info(): Blue [INFO] prefix
+- warn(): Yellow [WARN] prefix
+- error(): Red [ERROR] prefix
+
+Consolidates output formatting from jira_sync.py and provides
+a consistent interface for all CLI scripts.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+from typing import TextIO
+
+
+# ANSI color codes
+class Colors:
+    """ANSI escape codes for terminal colors."""
+
+    RED = "\x1b[31m"
+    GREEN = "\x1b[32m"
+    YELLOW = "\x1b[33m"
+    BLUE = "\x1b[34m"
+    MAGENTA = "\x1b[35m"
+    CYAN = "\x1b[36m"
+    BOLD = "\x1b[1m"
+    DIM = "\x1b[2m"
+    RESET = "\x1b[0m"
+
+
+def _supports_color(stream: TextIO) -> bool:
+    """Check if the output stream supports ANSI colors.
+
+    Args:
+        stream: Output stream to check
+
+    Returns:
+        True if colors are supported
+    """
+    # Check for NO_COLOR environment variable (standard)
+    if os.environ.get("NO_COLOR"):
+        return False
+
+    # Check for FORCE_COLOR environment variable
+    if os.environ.get("FORCE_COLOR"):
+        return True
+
+    # Check if stream is a TTY
+    if hasattr(stream, "isatty") and stream.isatty():
+        return True
+
+    return False
+
+
+def _colorize(text: str, color: str, stream: TextIO = sys.stderr) -> str:
+    """Apply color to text if supported.
+
+    Args:
+        text: Text to colorize
+        color: ANSI color code
+        stream: Output stream (for TTY detection)
+
+    Returns:
+        Colorized text or plain text if colors not supported
+    """
+    if _supports_color(stream):
+        return f"{color}{text}{Colors.RESET}"
+    return text
+
+
+def success(msg: str, file: TextIO = sys.stderr) -> None:
+    """Print success message with green [OK] prefix.
+
+    Args:
+        msg: Message to print
+        file: Output stream (default: stderr)
+    """
+    prefix = _colorize("[OK]", Colors.GREEN, file)
+    print(f"{prefix} {msg}", file=file)
+
+
+def info(msg: str, file: TextIO = sys.stderr) -> None:
+    """Print info message with blue [INFO] prefix.
+
+    Args:
+        msg: Message to print
+        file: Output stream (default: stderr)
+    """
+    prefix = _colorize("[INFO]", Colors.BLUE, file)
+    print(f"{prefix} {msg}", file=file)
+
+
+def warn(msg: str, file: TextIO = sys.stderr) -> None:
+    """Print warning message with yellow [WARN] prefix.
+
+    Args:
+        msg: Message to print
+        file: Output stream (default: stderr)
+    """
+    prefix = _colorize("[WARN]", Colors.YELLOW, file)
+    print(f"{prefix} {msg}", file=file)
+
+
+def error(msg: str, file: TextIO = sys.stderr) -> None:
+    """Print error message with red [ERROR] prefix.
+
+    Args:
+        msg: Message to print
+        file: Output stream (default: stderr)
+    """
+    prefix = _colorize("[ERROR]", Colors.RED, file)
+    print(f"{prefix} {msg}", file=file)
+
+
+def debug(msg: str, file: TextIO = sys.stderr) -> None:
+    """Print debug message with dim [DEBUG] prefix.
+
+    Args:
+        msg: Message to print
+        file: Output stream (default: stderr)
+    """
+    prefix = _colorize("[DEBUG]", Colors.DIM, file)
+    print(f"{prefix} {msg}", file=file)
+
+
+def header(msg: str, char: str = "=", width: int = 60, file: TextIO = sys.stderr) -> None:
+    """Print a header with decorative lines.
+
+    Args:
+        msg: Header text
+        char: Character for decoration line
+        width: Total width of the line
+        file: Output stream (default: stderr)
+    """
+    line = char * width
+    print(f"\n{line}", file=file)
+    print(msg, file=file)
+    print(line, file=file)
+
+
+def divider(char: str = "-", width: int = 40, file: TextIO = sys.stderr) -> None:
+    """Print a divider line.
+
+    Args:
+        char: Character for divider
+        width: Width of divider
+        file: Output stream (default: stderr)
+    """
+    print(char * width, file=file)
+
+
+def bold(text: str, stream: TextIO = sys.stdout) -> str:
+    """Return bold text if colors supported.
+
+    Args:
+        text: Text to make bold
+        stream: Output stream (for TTY detection)
+
+    Returns:
+        Bold text or plain text
+    """
+    return _colorize(text, Colors.BOLD, stream)
+
+
+def dim(text: str, stream: TextIO = sys.stdout) -> str:
+    """Return dimmed text if colors supported.
+
+    Args:
+        text: Text to dim
+        stream: Output stream (for TTY detection)
+
+    Returns:
+        Dimmed text or plain text
+    """
+    return _colorize(text, Colors.DIM, stream)

package/pennyfarthing_scripts/config.py

@@ -0,0 +1,21 @@
+"""
+Configuration loading utilities for Pennyfarthing scripts.
+
+This module re-exports from pennyfarthing_scripts.common.config for
+backwards compatibility. New code should import from common.config directly.
+"""
+
+# Re-export everything from the new location
+from pennyfarthing_scripts.common.config import (
+    find_project_root,
+    get_project_root,
+    load_pennyfarthing_config,
+    load_yaml_config,
+)
+
+__all__ = [
+    "find_project_root",
+    "get_project_root",
+    "load_pennyfarthing_config",
+    "load_yaml_config",
+]

package/pennyfarthing_scripts/git/__init__.py

@@ -0,0 +1,29 @@
+"""
+Git utilities for Pennyfarthing.
+
+Story: MSSCI-12402 - Port git utility scripts to Python
+
+This package provides async git operations for multi-repo management:
+- status_all: Check git status across all repos in parallel
+- create_branches: Create feature branches across repos in parallel
+"""
+
+from pennyfarthing_scripts.git.status_all import (
+    RepoStatus,
+    get_all_repo_status,
+    format_status_brief,
+    format_status_full,
+)
+from pennyfarthing_scripts.git.create_branches import (
+    BranchResult,
+    create_feature_branches,
+)
+
+__all__ = [
+    "RepoStatus",
+    "get_all_repo_status",
+    "format_status_brief",
+    "format_status_full",
+    "BranchResult",
+    "create_feature_branches",
+]