sqlsaber 0.26.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

sqlsaber/cli/onboarding.py

@@ -0,0 +1,325 @@
+"""Interactive onboarding flow for first-time SQLSaber users."""
+
+import sys
+
+from rich.console import Console
+from rich.panel import Panel
+
+from sqlsaber.cli.models import ModelManager
+from sqlsaber.config.api_keys import APIKeyManager
+from sqlsaber.config.auth import AuthConfigManager
+from sqlsaber.config.database import DatabaseConfigManager
+
+console = Console()
+
+
+def needs_onboarding(database_arg: str | None = None) -> bool:
+    """Check if user needs onboarding.
+
+    Onboarding is needed if:
+    - No database is configured AND no database connection string provided via CLI
+    """
+    # If user provided a database argument, skip onboarding
+    if database_arg:
+        return False
+
+    # Check if databases are configured
+    db_manager = DatabaseConfigManager()
+    has_db = db_manager.has_databases()
+
+    return not has_db
+
+
+def welcome_screen() -> None:
+    """Display welcome screen to new users."""
+    banner = """
+███████  ██████  ██      ███████  █████  ██████  ███████ ██████
+██      ██    ██ ██      ██      ██   ██ ██   ██ ██      ██   ██
+███████ ██    ██ ██      ███████ ███████ ██████  █████   ██████
+     ██ ██ ▄▄ ██ ██           ██ ██   ██ ██   ██ ██      ██   ██
+███████  ██████  ███████ ███████ ██   ██ ██████  ███████ ██   ██
+           ▀▀
+    """
+
+    console.print(Panel.fit(banner, style="bold blue"))
+    console.print()
+
+    welcome_message = """
+[bold]Welcome to SQLsaber! 🎉[/bold]
+
+SQLsaber is an agentic SQL assistant that lets you query your database using natural language.
+
+Let's get you set up in just a few steps.
+    """
+
+    console.print(Panel(welcome_message.strip(), border_style="blue", padding=(1, 2)))
+    console.print()
+
+
+async def setup_database_guided() -> str | None:
+    """Guide user through database setup.
+
+    Returns the name of the configured database or None if cancelled.
+    """
+    from sqlsaber.application.db_setup import (
+        build_config,
+        collect_db_input,
+        save_database,
+        test_connection,
+    )
+    from sqlsaber.application.prompts import AsyncPrompter
+
+    console.print("━" * 80, style="dim")
+    console.print("[bold cyan]Step 1 of 2: Database Connection[/bold cyan]")
+    console.print("━" * 80, style="dim")
+    console.print()
+
+    try:
+        # Ask for connection name
+        prompter = AsyncPrompter()
+        name = await prompter.text(
+            "What would you like to name this connection?",
+            default="mydb",
+            validate=lambda x: bool(x.strip()) or "Name cannot be empty",
+        )
+
+        if name is None:
+            return None
+
+        name = name.strip()
+
+        # Check if name already exists
+        db_manager = DatabaseConfigManager()
+        if db_manager.get_database(name):
+            console.print(
+                f"[yellow]Database connection '{name}' already exists.[/yellow]"
+            )
+            return name
+
+        # Collect database input (simplified - no SSL in onboarding)
+        db_input = await collect_db_input(
+            prompter=prompter, name=name, db_type="postgresql", include_ssl=False
+        )
+
+        if db_input is None:
+            return None
+
+        # Build config
+        db_config = build_config(db_input)
+
+        # Test the connection
+        console.print(f"[dim]Testing connection to '{name}'...[/dim]")
+        connection_success = await test_connection(db_config, db_input.password)
+
+        if not connection_success:
+            retry = await prompter.confirm(
+                "Would you like to try again with different settings?", default=True
+            )
+            if retry:
+                return await setup_database_guided()
+            else:
+                console.print(
+                    "[yellow]You can add a database later using 'saber db add'[/yellow]"
+                )
+                return None
+
+        # Save the configuration
+        try:
+            save_database(db_manager, db_config, db_input.password)
+            console.print(f"[green]✓ Connection to '{name}' successful![/green]")
+            console.print()
+            return name
+        except Exception as e:
+            console.print(f"[bold red]Error saving database:[/bold red] {e}")
+            return None
+
+    except KeyboardInterrupt:
+        console.print("\n[yellow]Setup cancelled.[/yellow]")
+        return None
+    except Exception as e:
+        console.print(f"[bold red]Unexpected error:[/bold red] {e}")
+        return None
+
+
+async def select_model_for_provider(provider: str) -> str | None:
+    """Fetch and let user select a model for the given provider.
+
+    Returns the selected model ID or None if cancelled/failed.
+    """
+    from sqlsaber.application.model_selection import choose_model, fetch_models
+    from sqlsaber.application.prompts import AsyncPrompter
+
+    try:
+        console.print()
+        console.print(f"[dim]Fetching available {provider.title()} models...[/dim]")
+
+        model_manager = ModelManager()
+        models = await fetch_models(model_manager, providers=[provider])
+
+        if not models:
+            console.print(
+                f"[yellow]Could not fetch models for {provider}. Using default.[/yellow]"
+            )
+            # Use provider-specific default or fallback to Anthropic
+            default_model_id = ModelManager.RECOMMENDED_MODELS.get(
+                provider, ModelManager.DEFAULT_MODEL
+            )
+            # Format it properly if we have a recommended model for this provider
+            if provider in ModelManager.RECOMMENDED_MODELS:
+                return f"{provider}:{ModelManager.RECOMMENDED_MODELS[provider]}"
+            return default_model_id
+
+        prompter = AsyncPrompter()
+        console.print()
+        selected_model = await choose_model(
+            prompter, models, restrict_provider=provider, use_search_filter=True
+        )
+
+        return selected_model
+
+    except KeyboardInterrupt:
+        console.print("\n[yellow]Model selection cancelled.[/yellow]")
+        return None
+    except Exception as e:
+        console.print(f"[yellow]Error selecting model: {e}. Using default.[/yellow]")
+        # Fallback to provider default
+        if provider in ModelManager.RECOMMENDED_MODELS:
+            return f"{provider}:{ModelManager.RECOMMENDED_MODELS[provider]}"
+        return ModelManager.DEFAULT_MODEL
+
+
+async def setup_auth_guided() -> tuple[bool, str | None]:
+    """Guide user through auth setup.
+
+    Returns tuple of (success: bool, selected_model: str | None).
+    """
+    from sqlsaber.application.auth_setup import setup_auth
+    from sqlsaber.application.prompts import AsyncPrompter
+
+    console.print("━" * 80, style="dim")
+    console.print("[bold cyan]Step 2 of 2: Authentication[/bold cyan]")
+    console.print("━" * 80, style="dim")
+    console.print()
+
+    try:
+        # Run auth setup
+        prompter = AsyncPrompter()
+        auth_manager = AuthConfigManager()
+        api_key_manager = APIKeyManager()
+
+        success, provider = await setup_auth(
+            prompter=prompter,
+            auth_manager=auth_manager,
+            api_key_manager=api_key_manager,
+            allow_oauth=True,
+            default_provider="anthropic",
+            run_oauth_in_thread=True,
+        )
+
+        if not success:
+            console.print(
+                "[yellow]You can set it up later using 'saber auth setup'[/yellow]"
+            )
+            console.print()
+            return False, None
+
+        # If auth configured but we don't know the provider (already configured case)
+        if provider is None:
+            console.print()
+            return True, None
+
+        # Select model for this provider
+        selected_model = await select_model_for_provider(provider)
+        if selected_model:
+            model_manager = ModelManager()
+            model_manager.set_model(selected_model)
+            console.print(f"[green]✓ Model set to: {selected_model}[/green]")
+        console.print()
+        return True, selected_model
+
+    except KeyboardInterrupt:
+        console.print("\n[yellow]Setup cancelled.[/yellow]")
+        console.print()
+        return False, None
+    except Exception as e:
+        console.print(f"[bold red]Unexpected error:[/bold red] {e}")
+        console.print()
+        return False, None
+
+
+def success_screen(
+    database_name: str | None, auth_configured: bool, model_name: str | None = None
+) -> None:
+    """Display success screen after onboarding."""
+    console.print("━" * 80, style="dim")
+    console.print("[bold green]You're all set! 🚀[/bold green]")
+    console.print("━" * 80, style="dim")
+    console.print()
+
+    if database_name and auth_configured:
+        console.print(
+            f"[green]✓ Database '{database_name}' connected and ready to use[/green]"
+        )
+        console.print("[green]✓ Authentication configured[/green]")
+        if model_name:
+            console.print(f"[green]✓ Model: {model_name}[/green]")
+    elif database_name:
+        console.print(
+            f"[green]✓ Database '{database_name}' connected and ready to use[/green]"
+        )
+        console.print(
+            "[yellow]⚠ AI authentication not configured - you'll be prompted when needed[/yellow]"
+        )
+    elif auth_configured:
+        console.print("[green]✓ AI authentication configured[/green]")
+        if model_name:
+            console.print(f"[green]✓ Model: {model_name}[/green]")
+        console.print(
+            "[yellow]⚠ No database configured - you'll need to provide one via -d flag[/yellow]"
+        )
+
+    console.print()
+    console.print("[dim]Starting interactive session...[/dim]")
+    console.print()
+
+
+async def run_onboarding() -> bool:
+    """Run the complete onboarding flow.
+
+    Returns True if onboarding completed successfully (at least database configured),
+    False if user cancelled or onboarding failed.
+    """
+    try:
+        # Welcome screen
+        welcome_screen()
+
+        # Database setup
+        database_name = await setup_database_guided()
+
+        # If user cancelled database setup, exit
+        if database_name is None:
+            console.print("[yellow]Database setup is required to continue.[/yellow]")
+            console.print(
+                "[dim]You can also provide a connection string using: saber -d <connection-string>[/dim]"
+            )
+            return False
+
+        # Auth setup
+        auth_configured, model_name = await setup_auth_guided()
+
+        # Show success screen
+        success_screen(database_name, auth_configured, model_name)
+
+        return True
+
+    except KeyboardInterrupt:
+        console.print("\n[yellow]Onboarding cancelled.[/yellow]")
+        console.print(
+            "[dim]You can run setup commands manually:[/dim]\n"
+            "[dim]  - saber db add <name>  # Add database connection[/dim]\n"
+            "[dim]  - saber auth setup     # Configure authentication[/dim]"
+        )
+        sys.exit(0)
+    except Exception as e:
+        console.print(f"[bold red]Onboarding failed:[/bold red] {e}")
+        return False

sqlsaber/config/api_keys.py

@@ -19,7 +19,7 @@ class APIKeyManager:
 
     def get_api_key(self, provider: str) -> str | None:
         """Get API key for the specified provider using cascading logic."""
-        env_var_name = self._get_env_var_name(provider)
+        env_var_name = self.get_env_var_name(provider)
         service_name = self._get_service_name(provider)
 
         # 1. Check environment variable first
@@ -41,7 +41,7 @@ class APIKeyManager:
         # 3. Prompt user for API key
         return self._prompt_and_store_key(provider, env_var_name, service_name)
 
-    def _get_env_var_name(self, provider: str) -> str:
+    def get_env_var_name(self, provider: str) -> str:
         """Get the expected environment variable name for a provider."""
         # Normalize aliases to canonical provider keys
         key = providers.canonical(provider) or provider

{sqlsaber-0.26.0.dist-info → sqlsaber-0.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlsaber
-Version: 0.26.0
+Version: 0.27.0
 Summary: SQLsaber - Open-source agentic SQL assistant
 License-File: LICENSE
 Requires-Python: >=3.12

{sqlsaber-0.26.0.dist-info → sqlsaber-0.27.0.dist-info}/RECORD

@@ -4,19 +4,25 @@ sqlsaber/agents/__init__.py,sha256=qYI6rLY4q5AbF47vXH5RVoM08-yQjymBSaePh4lFIW4,1
 sqlsaber/agents/base.py,sha256=40-MKEoz5rGrqVIylV1U2DaAUSPFcC75ohRin4E3-kk,2668
 sqlsaber/agents/mcp.py,sha256=Pn8tdDRUEVLYQyEi5nHRp9MKNePwHVVoeNI-uqWcr0Y,757
 sqlsaber/agents/pydantic_ai_agent.py,sha256=wBxKz0pjOkL-HI-TXV6B67bczZNgu7k26Rr3w5usR3o,10064
+sqlsaber/application/__init__.py,sha256=KY_-d5nEdQyAwNOsK5r-f7Tb69c63XbuEkHPeLpJal8,84
+sqlsaber/application/auth_setup.py,sha256=aIZ4vyfdjO5zCcMy4k4FmqjeGgruypPIRacaOJDuVRY,5080
+sqlsaber/application/db_setup.py,sha256=VipoXACDVs8auYs7XeuNYrUWjVHpxqxWphx9yUl1_2I,6826
+sqlsaber/application/model_selection.py,sha256=eRWga3vRpoyyTmw0BsVDRvUtyUnxvP8plAQ2Nv7tN3o,3163
+sqlsaber/application/prompts.py,sha256=4rMGcWpYJbNWPMzqVWseUMx0nwvXOkWS6GaTAJ5mhfc,3473
 sqlsaber/cli/__init__.py,sha256=qVSLVJLLJYzoC6aj6y9MFrzZvAwc4_OgxU9DlkQnZ4M,86
-sqlsaber/cli/auth.py,sha256=jTsRgbmlGPlASSuIKmdjjwfqtKvjfKd_cTYxX0-QqaQ,7400
-sqlsaber/cli/commands.py,sha256=n25CErTLgLeRSkoJI0Ickwtns5EH6O7RLVPgPs6UBxA,7986
+sqlsaber/cli/auth.py,sha256=Hz7nuHdX1iMr2UR1VVtu4EAvBYYIhsgthluqpiOXH2A,6064
+sqlsaber/cli/commands.py,sha256=R63HF4P0JZwbGlI3TimkEUg3OUaFXYkVvLw1VIy0UFI,8516
 sqlsaber/cli/completers.py,sha256=g-hLDq5fiBx7gg8Bte1Lq8GU-ZxCYVs4dcPsmHPIcK4,6574
-sqlsaber/cli/database.py,sha256=qil7nZGWKm3tULL0cUsAQ_KvhU1oikK0XVh9MibrvP0,13413
-sqlsaber/cli/display.py,sha256=32QaNS0RDgRz93AVy6nPo9blahvMPEoVMFC5spzh0-Y,17041
-sqlsaber/cli/interactive.py,sha256=jGbWNNcEgZuQRZamc5tX5eIf1Rv1T6Sj5NI_WvonTrA,13624
+sqlsaber/cli/database.py,sha256=6SdxNuP8w-e2nbV937q4hxfAIwKu1MqoirogD7USaMU,10639
+sqlsaber/cli/display.py,sha256=JQBSdLC_a3nkmJ4QfLMhhMPCYY-otS2eXF1XrfEe19E,17045
+sqlsaber/cli/interactive.py,sha256=RG4DJN9lprfKi60eomxVt-w3gTsWoqbfEcfO36iibXM,13694
 sqlsaber/cli/memory.py,sha256=OufHFJFwV0_GGn7LvKRTJikkWhV1IwNIUDOxFPHXOaQ,7794
-sqlsaber/cli/models.py,sha256=ZewtwGQwhd9b-yxBAPKePolvI1qQG-EkmeWAGMqtWNQ,8986
+sqlsaber/cli/models.py,sha256=v_wrJWV5NXiM3zGLSMyNJf4YhgozK6hnf76Ua8HvysE,8480
+sqlsaber/cli/onboarding.py,sha256=5p-rHG2eGM-7t9yg_kNDrXpY13jr__dlFII3K69VtKc,11414
 sqlsaber/cli/streaming.py,sha256=YViLCxUv-7WN5TCphLYtAR02HXvuHYuPttGGDZKDUKU,6921
 sqlsaber/cli/threads.py,sha256=zVlbOuD3GjjEVNebXwANKeKt4I_Lunf6itiBUL0TaKA,12877
 sqlsaber/config/__init__.py,sha256=olwC45k8Nc61yK0WmPUk7XHdbsZH9HuUAbwnmKe3IgA,100
-sqlsaber/config/api_keys.py,sha256=RqWQCko1tY7sES7YOlexgBH5Hd5ne_kGXHdBDNqcV2U,3649
+sqlsaber/config/api_keys.py,sha256=7X63B-ow66GZWzYYgc_7f1T26F7gRhfyYQM4RpdkCpI,3647
 sqlsaber/config/auth.py,sha256=b5qB2h1doXyO9Bn8z0CcL8LAR2jF431gGXBGKLgTmtQ,2756
 sqlsaber/config/database.py,sha256=Yec6_0wdzq-ADblMNnbgvouYCimYOY_DWHT9oweaISc,11449
 sqlsaber/config/oauth_flow.py,sha256=A3bSXaBLzuAfXV2ZPA94m9NV33c2MyL6M4ii9oEkswQ,10291
@@ -45,8 +51,8 @@ sqlsaber/tools/enums.py,sha256=CH32mL-0k9ZA18911xLpNtsgpV6tB85TktMj6uqGz54,411
 sqlsaber/tools/instructions.py,sha256=X-x8maVkkyi16b6Tl0hcAFgjiYceZaSwyWTfmrvx8U8,9024
 sqlsaber/tools/registry.py,sha256=HWOQMsNIdL4XZS6TeNUyrL-5KoSDH6PHsWd3X66o-18,3211
 sqlsaber/tools/sql_tools.py,sha256=2xLD_pkd0t8wKndQAKIr4c9UpWzVWeHbAFpkwo5j4kY,9954
-sqlsaber-0.26.0.dist-info/METADATA,sha256=o4vaJVAG_1U5Tybcx2MY3lX0FvYjBEdKxFDWhFC9xYs,7138
-sqlsaber-0.26.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sqlsaber-0.26.0.dist-info/entry_points.txt,sha256=qEbOB7OffXPFgyJc7qEIJlMEX5RN9xdzLmWZa91zCQQ,162
-sqlsaber-0.26.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-sqlsaber-0.26.0.dist-info/RECORD,,
+sqlsaber-0.27.0.dist-info/METADATA,sha256=-QcrEttuC3vwUmNdtjHzA_laIfTkcMGoghmSCvNn3nM,7138
+sqlsaber-0.27.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sqlsaber-0.27.0.dist-info/entry_points.txt,sha256=qEbOB7OffXPFgyJc7qEIJlMEX5RN9xdzLmWZa91zCQQ,162
+sqlsaber-0.27.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sqlsaber-0.27.0.dist-info/RECORD,,