golf-mcp 0.2.16__py3-none-any.whl

golf/auth/registry.py

@@ -0,0 +1,256 @@
+"""Provider registry system for extensible authentication providers.
+
+This module provides a registry-based dispatch system that allows custom
+authentication providers to be added without modifying the core factory code.
+"""
+
+from typing import Protocol, TYPE_CHECKING
+from abc import ABC, abstractmethod
+
+if TYPE_CHECKING:
+    from fastmcp.server.auth.auth import AuthProvider
+
+from .providers import AuthConfig
+
+
+class AuthProviderFactory(Protocol):
+    """Protocol for auth provider factory functions.
+
+    Custom provider factories must implement this interface to be compatible
+    with the registry system.
+    """
+
+    def __call__(self, config: AuthConfig) -> "AuthProvider":
+        """Create an AuthProvider from configuration.
+
+        Args:
+            config: Authentication configuration object
+
+        Returns:
+            Configured FastMCP AuthProvider instance
+
+        Raises:
+            ValueError: If configuration is invalid
+            ImportError: If required dependencies are missing
+        """
+        ...
+
+
+class BaseProviderPlugin(ABC):
+    """Base class for auth provider plugins.
+
+    Provider plugins can extend this class to provide both configuration
+    and factory logic in a single cohesive unit.
+    """
+
+    @property
+    @abstractmethod
+    def provider_type(self) -> str:
+        """Return the provider type identifier."""
+        ...
+
+    @property
+    @abstractmethod
+    def config_class(self) -> type[AuthConfig]:
+        """Return the configuration class for this provider."""
+        ...
+
+    @abstractmethod
+    def create_provider(self, config: AuthConfig) -> "AuthProvider":
+        """Create the auth provider from configuration.
+
+        Args:
+            config: Authentication configuration (must be instance of config_class)
+
+        Returns:
+            Configured FastMCP AuthProvider instance
+        """
+        ...
+
+    def validate_config(self, config: AuthConfig) -> None:
+        """Validate the configuration before creating provider.
+
+        Override this method to add custom validation logic.
+        Default implementation checks config is correct type.
+
+        Args:
+            config: Configuration to validate
+
+        Raises:
+            ValueError: If configuration is invalid
+        """
+        if not isinstance(config, self.config_class):
+            raise ValueError(
+                f"Expected {self.config_class.__name__} for {self.provider_type} provider, got {type(config).__name__}"
+            )
+
+
+class AuthProviderRegistry:
+    """Registry for authentication provider factories and plugins.
+
+    This registry allows custom authentication providers to be registered
+    without modifying the core factory code. Providers can be registered
+    either as simple factory functions or as full plugin classes.
+    """
+
+    def __init__(self) -> None:
+        self._factories: dict[str, AuthProviderFactory] = {}
+        self._plugins: dict[str, BaseProviderPlugin] = {}
+
+    def register_factory(self, provider_type: str, factory: AuthProviderFactory) -> None:
+        """Register a factory function for a provider type.
+
+        Args:
+            provider_type: Unique identifier for the provider type
+            factory: Factory function that creates providers
+
+        Raises:
+            ValueError: If provider_type is already registered
+        """
+        if provider_type in self._factories or provider_type in self._plugins:
+            raise ValueError(f"Provider type '{provider_type}' is already registered")
+
+        self._factories[provider_type] = factory
+
+    def register_plugin(self, plugin: BaseProviderPlugin) -> None:
+        """Register a provider plugin.
+
+        Args:
+            plugin: Provider plugin instance
+
+        Raises:
+            ValueError: If provider type is already registered
+        """
+        provider_type = plugin.provider_type
+        if provider_type in self._factories or provider_type in self._plugins:
+            raise ValueError(f"Provider type '{provider_type}' is already registered")
+
+        self._plugins[provider_type] = plugin
+
+    def unregister(self, provider_type: str) -> None:
+        """Unregister a provider type.
+
+        Args:
+            provider_type: Provider type to remove
+
+        Raises:
+            KeyError: If provider type is not registered
+        """
+        if provider_type in self._factories:
+            del self._factories[provider_type]
+        elif provider_type in self._plugins:
+            del self._plugins[provider_type]
+        else:
+            raise KeyError(f"Provider type '{provider_type}' is not registered")
+
+    def get_factory(self, provider_type: str) -> AuthProviderFactory:
+        """Get factory function for a provider type.
+
+        Args:
+            provider_type: Provider type to look up
+
+        Returns:
+            Factory function for the provider type
+
+        Raises:
+            KeyError: If provider type is not registered
+        """
+        # Check factories first
+        if provider_type in self._factories:
+            return self._factories[provider_type]
+
+        # Check plugins
+        if provider_type in self._plugins:
+            plugin = self._plugins[provider_type]
+
+            # Wrap plugin method to match factory signature
+            def plugin_factory(config: AuthConfig) -> "AuthProvider":
+                plugin.validate_config(config)
+                return plugin.create_provider(config)
+
+            return plugin_factory
+
+        raise KeyError(f"No provider registered for type '{provider_type}'")
+
+    def create_provider(self, config: AuthConfig) -> "AuthProvider":
+        """Create a provider from configuration using the registry.
+
+        Args:
+            config: Authentication configuration
+
+        Returns:
+            Configured AuthProvider instance
+
+        Raises:
+            KeyError: If provider type is not registered
+            ValueError: If configuration is invalid
+        """
+        provider_type = getattr(config, "provider_type", None)
+        if not provider_type:
+            raise ValueError(f"Configuration {type(config).__name__} missing provider_type attribute")
+
+        factory = self.get_factory(provider_type)
+        return factory(config)
+
+    def list_providers(self) -> list[str]:
+        """List all registered provider types.
+
+        Returns:
+            List of provider type identifiers
+        """
+        return sorted(list(self._factories.keys()) + list(self._plugins.keys()))
+
+    def is_registered(self, provider_type: str) -> bool:
+        """Check if a provider type is registered.
+
+        Args:
+            provider_type: Provider type to check
+
+        Returns:
+            True if provider type is registered
+        """
+        return provider_type in self._factories or provider_type in self._plugins
+
+
+# Global registry instance
+_default_registry = AuthProviderRegistry()
+
+
+def get_provider_registry() -> AuthProviderRegistry:
+    """Get the default provider registry.
+
+    Returns:
+        Default AuthProviderRegistry instance
+    """
+    return _default_registry
+
+
+def register_provider_factory(provider_type: str, factory: AuthProviderFactory) -> None:
+    """Register a factory function in the default registry.
+
+    Args:
+        provider_type: Unique identifier for the provider type
+        factory: Factory function that creates providers
+    """
+    _default_registry.register_factory(provider_type, factory)
+
+
+def register_provider_plugin(plugin: BaseProviderPlugin) -> None:
+    """Register a provider plugin in the default registry.
+
+    Args:
+        plugin: Provider plugin instance
+    """
+    _default_registry.register_plugin(plugin)
+
+
+def create_auth_provider_from_registry(config: AuthConfig) -> "AuthProvider":
+    """Create an auth provider using the default registry.
+
+    Args:
+        config: Authentication configuration
+
+    Returns:
+        Configured AuthProvider instance
+    """
+    return _default_registry.create_provider(config)

golf/cli/__init__.py

@@ -0,0 +1 @@
+"""CLI package for the GolfMCP framework."""

golf/cli/branding.py

@@ -0,0 +1,191 @@
+"""Golf CLI branding and visual utilities."""
+
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+from rich.align import Align
+
+# Golf brand colors (official brand colors)
+GOLF_BLUE = "#2969FD"  # Primary blue from brand: rgb(41, 105, 253)
+GOLF_ORANGE = "#F97728"  # Secondary orange from brand: rgb(249, 119, 40)
+GOLF_GREEN = "#10B981"  # Success green
+GOLF_WHITE = "#FFFFFF"
+
+# Simple GolfMCP text logo
+GOLF_LOGO = """
+ ██████╗  ██████╗ ██╗     ███████╗███╗   ███╗ ██████╗██████╗ 
+██╔════╝ ██╔═══██╗██║     ██╔════╝████╗ ████║██╔════╝██╔══██╗
+██║  ███╗██║   ██║██║     █████╗  ██╔████╔██║██║     ██████╔╝
+██║   ██║██║   ██║██║     ██╔══╝  ██║╚██╔╝██║██║     ██╔═══╝ 
+╚██████╔╝╚██████╔╝███████╗██║     ██║ ╚═╝ ██║╚██████╗██║     
+ ╚═════╝  ╚═════╝ ╚══════╝╚═╝     ╚═╝     ╚═╝ ╚═════╝╚═╝     
+"""
+
+# Simplified version for smaller spaces
+GOLF_LOGO_SMALL = "Golf"
+
+# Status icons with consistent styling
+STATUS_ICONS = {
+    "success": "✓",
+    "error": "✗",
+    "warning": "⚠",
+    "info": "ℹ",
+    "building": "🔨",
+    "generating": "⚙️",
+    "packaging": "📦",
+    "server": "🚀",
+    "loading": "⭕",
+}
+
+
+def create_welcome_banner(version: str, console: Console) -> None:
+    """Create the main Golf welcome banner."""
+    # Create the logo with Golf in blue and MCP in orange
+    logo_lines = GOLF_LOGO.strip().split("\n")
+    logo_content = Text()
+
+    for line in logo_lines:
+        if line.strip():  # Only process non-empty lines
+            # Find where "MCP" starts (roughly at position 32 in the ASCII art)
+            golf_part = line[:32]  # First part is "Golf"
+            mcp_part = line[32:]  # Last part is "MCP"
+
+            logo_content.append(golf_part, style=f"bold {GOLF_BLUE}")
+            logo_content.append(mcp_part, style=f"bold {GOLF_ORANGE}")
+        logo_content.append("\n")
+
+    # Create version line
+    version_text = Text()
+    version_text.append("🚀 ", style=f"bold {GOLF_ORANGE}")
+    version_text.append(f"Golf v{version}", style=f"bold {GOLF_BLUE}")
+    version_text.append(" 🚀", style=f"bold {GOLF_ORANGE}")
+
+    # Create tagline
+    tagline_text = Text("✨ Easiest way to build production-ready MCP servers ✨", style="bold white")
+
+    # Create the full content using a renderable group approach
+    from rich.console import Group
+
+    content_group = Group(
+        Align.center(logo_content),
+        "",  # Empty line for spacing
+        Align.center(version_text),
+        Align.center(tagline_text),
+    )
+
+    panel = Panel(
+        content_group,
+        border_style=GOLF_BLUE,
+        padding=(1, 2),
+        title="[bold]🏌️ Welcome to Golf 🏌️[/bold]",
+        title_align="center",
+    )
+
+    console.print(panel)
+
+
+def create_command_header(title: str, subtitle: str = "", console: Console | None = None) -> None:
+    """Create a styled command header."""
+    if console is None:
+        console = Console()
+
+    header = Text()
+    header.append("🏌️ ", style=f"bold {GOLF_ORANGE}")
+    header.append(title, style=f"bold {GOLF_BLUE}")
+
+    if subtitle:
+        header.append(f" → {subtitle}", style=f"bold {GOLF_ORANGE}")
+
+    # Create a stylish panel for the header
+    panel = Panel(
+        Align.center(header),
+        border_style=GOLF_BLUE,
+        padding=(0, 2),
+    )
+
+    console.print(panel)
+
+
+def create_success_message(message: str, console: Console | None = None) -> None:
+    """Create a styled success message."""
+    if console is None:
+        console = Console()
+
+    success_content = Text()
+    success_content.append("🎉 ", style=f"bold {GOLF_ORANGE}")
+    success_content.append(f"{STATUS_ICONS['success']} {message}", style=f"bold {GOLF_GREEN}")
+    success_content.append(" 🎉", style=f"bold {GOLF_ORANGE}")
+
+    success_panel = Panel(
+        Align.center(success_content),
+        border_style=GOLF_GREEN,
+        padding=(0, 2),
+        title="[bold green]SUCCESS[/bold green]",
+        title_align="center",
+    )
+    console.print(success_panel)
+
+
+def create_info_panel(title: str, content: str, console: Console | None = None) -> None:
+    """Create a styled info panel."""
+    if console is None:
+        console = Console()
+
+    # Add some visual flair to the content
+    styled_content = Text()
+    for line in content.split("\n"):
+        if line.strip():
+            styled_content.append("▶ ", style=f"bold {GOLF_ORANGE}")
+            styled_content.append(line, style="bold white")
+            styled_content.append("\n")
+
+    panel = Panel(
+        styled_content,
+        title=f"[bold {GOLF_BLUE}]🔧 {title} 🔧[/bold {GOLF_BLUE}]",
+        border_style=GOLF_BLUE,
+        padding=(1, 2),
+    )
+    console.print(panel)
+
+
+def get_status_text(status: str, message: str, style: str = "") -> Text:
+    """Get formatted status text with icon."""
+    icon = STATUS_ICONS.get(status, "•")
+    text = Text()
+
+    if status == "success":
+        text.append("🎉 ", style=f"bold {GOLF_ORANGE}")
+        text.append(f"{icon} {message}", style=f"bold {GOLF_GREEN}")
+    elif status == "error":
+        text.append("💥 ", style=f"bold {GOLF_ORANGE}")
+        text.append(f"{icon} {message}", style="bold red")
+    elif status == "warning":
+        text.append("⚡ ", style=f"bold {GOLF_ORANGE}")
+        text.append(f"{icon} {message}", style=f"bold {GOLF_ORANGE}")
+    elif status in ["building", "generating", "packaging"]:
+        text.append("🔥 ", style=f"bold {GOLF_ORANGE}")
+        text.append(f"{icon} {message}", style=f"bold {GOLF_BLUE}")
+    else:
+        text.append("💡 ", style=f"bold {GOLF_ORANGE}")
+        text.append(f"{icon} {message}", style=f"bold {GOLF_BLUE}")
+
+    return text
+
+
+def create_build_header(project_name: str, environment: str, console: Console) -> None:
+    """Create a styled build process header."""
+    title = Text()
+    title.append("🔨 Building ", style=f"bold {GOLF_ORANGE}")
+    title.append(project_name, style=f"bold {GOLF_BLUE}")
+    title.append(f" ({environment} environment)", style=f"bold {GOLF_GREEN}")
+
+    # Create a flashy build panel
+    panel = Panel(
+        Align.center(title),
+        border_style=GOLF_ORANGE,
+        padding=(0, 2),
+        title="[bold]🚧 BUILD IN PROGRESS 🚧[/bold]",
+        title_align="center",
+    )
+
+    console.print(panel)