sqlsaber 0.18.0__tar.gz → 0.19.0__tar.gz

{sqlsaber-0.18.0 → sqlsaber-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlsaber
-Version: 0.18.0
+Version: 0.19.0
 Summary: SQLsaber - Open-source agentic SQL assistant
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -13,6 +13,7 @@ Requires-Dist: httpx>=0.28.1
 Requires-Dist: keyring>=25.6.0
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: prompt-toolkit>3.0.51
 Requires-Dist: pydantic-ai
 Requires-Dist: questionary>=2.1.0
 Requires-Dist: rich>=13.7.0

sqlsaber-0.19.0/docs/CLAUDE.md

@@ -0,0 +1,40 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+- **Development server**: `npm run dev` or `npm start`
+- **Build documentation**: `npm run build`
+- **Preview built site**: `npm run preview`
+
+## Architecture
+
+- **Documentation Site**: Built with Astro and Starlight for SQLsaber project documentation
+- **Framework**: Astro 5.x with Starlight integration for documentation structure
+- **Styling**: TailwindCSS 4.x with Starlight-specific Tailwind integration
+- **Content**: MDX files in `src/content/docs/` for documentation pages
+- **Assets**: Static images and SVGs in `src/assets/` and `public/`
+
+## Project Context
+
+This is the documentation website (`/docs`) for SQLsaber, an open-source agentic SQL assistant. The main SQLsaber Python project is in the parent directory with its own development workflow using uv/Python.
+
+Key documentation areas:
+- Landing page: `src/content/docs/index.mdx` (splash template with hero section)
+- Guides: `src/content/docs/guides/` (tutorial content)
+- Reference: `src/content/docs/reference/` (API and technical reference)
+
+## Configuration Files
+
+- `astro.config.mjs`: Main Astro configuration with Starlight integration
+- `package.json`: Node.js dependencies and scripts
+- `tsconfig.json`: TypeScript configuration for the Astro project
+- Site URL configured for https://sqlsaber.com
+
+## Content Structure
+
+- Starlight sidebar automatically generates from `src/content/docs/` structure
+- Use `.mdx` extension for components in markdown
+- Use components available via `@astrojs/starlight/components`
+- Asciinema integration for terminal recordings/demos

sqlsaber-0.19.0/docs/astro.config.mjs

@@ -0,0 +1,57 @@
+// @ts-check
+
+import starlight from "@astrojs/starlight";
+import tailwindcss from "@tailwindcss/vite";
+import { defineConfig } from "astro/config";
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [
+		starlight({
+			title: "SQLsaber",
+			customCss: ["./src/styles/global.css"],
+			social: [
+				{
+					icon: "github",
+					label: "GitHub",
+					href: "https://github.com/SarthakJariwala/sqlsaber",
+				},
+			],
+			sidebar: [
+				{
+					label: "Getting Started",
+					items: [
+						{ label: "Installation", slug: "installation" },
+						{ label: "Quick Start", slug: "guides/getting-started" },
+					],
+				},
+				{
+					label: "Guides", 
+					items: [
+						{ label: "Database Setup", slug: "guides/database-setup" },
+						{ label: "Authentication", slug: "guides/authentication" },
+						{ label: "Models", slug: "guides/models" },
+						{ label: "Running Queries", slug: "guides/queries" },
+						{ label: "Conversation Threads", slug: "guides/threads" },
+						{ label: "Memory Management", slug: "guides/memory" },
+					],
+				},
+				{
+					label: "Reference",
+					items: [
+						{ label: "Commands", slug: "reference/commands" },
+					],
+				},
+				{
+					label: "Project",
+					items: [
+						{ label: "Changelog", slug: "changelog" },
+					],
+				},
+			],
+		}),
+	],
+	vite: { plugins: [tailwindcss()] },
+
+	site: "https://sqlsaber.com",
+});

sqlsaber-0.18.0/CHANGELOG.md → sqlsaber-0.19.0/docs/src/content/docs/changelog.md

@@ -1,18 +1,34 @@
-# Changelog
+---
+title: Changelog
+description: Release history and notable changes to SQLsaber
+---
 
 All notable changes to SQLsaber will be documented here.
 
-## [Unreleased]
+### Unreleased
 
-## [0.18.0] - 2025-09-08
+---
 
-### Changed
+### v0.19.0 - 2025-09-09
+
+#### Added
+
+- Notable improvements to user prompt interface
+  - Ctrl+D to exit the application without having to use "/exit" or "/quit" slash command
+  - Display multiline input submission info as bottom toolbar
+  - Pressing up and down arrow keys now help navigate through prior user prompts
+  - Visual improvements to user prompt area
+  - Added mouse support - users can now click around text to edit
+
+### v0.18.0 - 2025-09-08
+
+#### Changed
 
 - Improved CLI startup time
 
-## [0.17.0] - 2025-09-08
+### v0.17.0 - 2025-09-08
 
-### Added
+#### Added
 
 - Conversation threads system for storing, displaying, and resuming conversations
   - Automatic thread creation for both interactive and non-interactive sessions
@@ -23,28 +39,28 @@ All notable changes to SQLsaber will be documented here.
   - Thread persistence with metadata (title, model, database, last activity)
   - Seamless resumption of conversation context and history
 
-### Removed
+#### Removed
 
 - Removed visualization tools and plotting capabilities
   - Removed PlotDataTool and uniplot dependency
   - Cleaned up visualization-related code from CLI, registry, and instructions
 
-## [0.16.1] - 2025-09-04
+### v0.16.1 - 2025-09-04
 
-### Added
+#### Added
 
 - Compile python byte code during installation
 - Updated CLI help string
 
-## [0.16.0] - 2025-09-04
+### v0.16.0 - 2025-09-04
 
-### Added
+#### Added
 
 - Migrated to Pydantic-AI agent runtime with model-agnostic interfaces
 - Added multi-provider model support: Anthropic, OpenAI, Google, Groq, Mistral, Cohere, Hugging Face
 - Provider registry tests to ensure invariants and alias normalization
 
-### Changed
+#### Changed
 
 - Reworked agents to use new pydantic-ai-based agent implementation
 - Updated CLI modules and settings to integrate provider selection and authentication
@@ -55,28 +71,28 @@ All notable changes to SQLsaber will be documented here.
 - Centralized provider definitions in `sqlsaber.config.providers` and refactored CLI, config, and agent code to use the registry (single source of truth)
 - Normalized provider aliases (e.g., `google-gla` → `google`) for consistent behavior across modules
 
-### Removed
+#### Removed
 
 - Deprecated custom `clients` module and Anthropic-specific client code
 - Removed legacy streaming and events modules and related tests
 
-## [0.15.0] - 2025-08-18
+### v0.15.0 - 2025-08-18
 
-### Added
+#### Added
 
 - Tool abstraction system with centralized registry (new `Tool` base class, `ToolRegistry`, decorators)
 - Dynamic instruction generation system (`InstructionBuilder`)
 - Comprehensive test suite for the tools module
 
-### Changed
+#### Changed
 
 - Refactored agents to use centralized tool registry instead of hardcoded tools
 - Enhanced MCP server with dynamic tool registration
 - Moved core SQL functionality to dedicated tool classes
 
-## [0.14.0] - 2025-08-01
+### v0.14.0 - 2025-08-01
 
-### Added
+#### Added
 
 - Local conversation storage between user and agent
   - Store conversation history persistently
@@ -85,49 +101,49 @@ All notable changes to SQLsaber will be documented here.
   - New GitHub Actions workflow for running tests
   - Updated code review workflow
 
-### Fixed
+#### Fixed
 
 - Fixed CLI commands test suite (#11)
 
-### Changed
+#### Changed
 
 - Removed schema caching from SchemaManager
   - Simplified schema introspection by removing cache logic
   - Direct database queries for schema information
 
-## [0.13.0] - 2025-07-26
+### v0.13.0 - 2025-07-26
 
-### Added
+#### Added
 
 - Database resolver abstraction for unified connection handling
   - Extended `-d` flag to accept PostgreSQL and MySQL connection strings (e.g., `postgresql://user:pass@host:5432/db`)
   - Support for direct connection strings alongside existing file path and configured database support
   - Examples: `saber -d "postgresql://user:pass@host:5432/db" "show users"`
 
-## [0.12.0] - 2025-07-23
+### v0.12.0 - 2025-07-23
 
-### Added
+#### Added
 
 - Add support for ad-hoc SQLite files via `--database`/`-d` flag
 
-## [0.11.0] - 2025-07-09
+### v0.11.0 - 2025-07-09
 
-### Changed
+#### Changed
 
 - Removed row counting from `list_tables` tool for all database types
 
-## [0.10.0] - 2025-07-08
+### v0.10.0 - 2025-07-08
 
-### Added
+#### Added
 
 - Support for reading queries from stdin via pipe operator
   - `echo 'show me all users' | saber` now works
   - `cat query.txt | saber` reads query from file via stdin
   - Allows integration with other command-line tools and scripts
 
-## [0.9.0] - 2025-07-08
+### v0.9.0 - 2025-07-08
 
-### Changed
+#### Changed
 
 - Migrated from Typer to Cyclopts for CLI framework
   - Improved command structure and parameter handling
@@ -137,22 +153,22 @@ All notable changes to SQLsaber will be documented here.
   - `saber "question"` executes a single query (previously `saber query "question"`)
   - Removed the `query` subcommand for a cleaner interface
 
-## [0.8.2] - 2025-07-08
+### v0.8.2 - 2025-07-08
 
-## Changed
+#### Changed
 
 - Updated formatting for final answer display
 - New ASCII art in interactive mode
 
-## [0.8.1] - 2025-07-07
+### v0.8.1 - 2025-07-07
 
-### Fixed
+#### Fixed
 
 - Fixed OAuth validation logic to not require API key when Claude Pro OAuth is configured
 
-## [0.8.0] - 2025-07-07
+### v0.8.0 - 2025-07-07
 
-### Added
+#### Added
 
 - OAuth support for Claude Pro/Max subscriptions
 - Authentication management with `saber auth` command
@@ -164,28 +180,27 @@ All notable changes to SQLsaber will be documented here.
 - New `clients` module with custom Anthropic API client
   - `AnthropicClient` for direct API communication
 
-### Changed
+#### Changed
 
 - Enhanced authentication system to support both API keys and OAuth tokens
 - Replaced Anthropic SDK with direct API implementation using httpx
 - Modernized type annotations throughout the codebase
 - Refactored query streaming into smaller, more maintainable functions
 
-## [0.7.0] - 2025-07-01
+### v0.7.0 - 2025-07-01
 
-### Added
+#### Added
 
 - Table name autocomplete with "@" prefix in interactive mode
-
   - Type "@" followed by table name to get fuzzy matching completions
   - Supports schema-aware completions (e.g., "@sample" matches "public.sample")
 
 - Rich markdown display for assistant responses
   - After streaming completes, the final response is displayed as formatted markdown
 
-## [0.6.0] - 2025-06-30
+### v0.6.0 - 2025-06-30
 
-### Added
+#### Added
 
 - Slash command autocomplete in interactive mode
   - Commands now use slash prefix: `/clear`, `/exit`, `/quit`
@@ -195,7 +210,7 @@ All notable changes to SQLsaber will be documented here.
   - Press Ctrl+C during query execution to gracefully cancel ongoing operations
   - Preserves conversation history up to the interruption point
 
-### Changed
+#### Changed
 
 - Updated table display for better readability: limit to first 15 columns on wide tables
   - Shows warning when columns are truncated
@@ -205,47 +220,47 @@ All notable changes to SQLsaber will be documented here.
   - `quit` → `/quit`
 - Removed default limit of 100. Now model will decide it.
 
-## [0.5.0] - 2025-06-27
+### v0.5.0 - 2025-06-27
 
-### Added
+#### Added
 
 - Added support for plotting data from query results.
   - The agent can decide if plotting will useful and create a plot with query results.
 - Small updates to system prompt
 
-## [0.4.1] - 2025-06-26
+### v0.4.1 - 2025-06-26
 
-### Added
+#### Added
 
 - Show connected database information at the start of a session
 - Update welcome message for clarity
 
-## [0.4.0] - 2025-06-25
+### v0.4.0 - 2025-06-25
 
-### Added
+#### Added
 
 - MCP (Model Context Protocol) server support
 - `saber-mcp` console script for running MCP server
 - MCP tools: `get_databases()`, `list_tables()`, `introspect_schema()`, `execute_sql()`
 - Instructions and documentation for configuring MCP clients (Claude Code, etc.)
 
-## [0.3.0] - 2025-06-25
+### v0.3.0 - 2025-06-25
 
-### Added
+#### Added
 
 - Support for CSV files as a database option: `saber query -d mydata.csv`
 
-### Changed
+#### Changed
 
 - Extracted tools to BaseSQLAgent for better inheritance across SQLAgents
 
-### Fixed
+#### Fixed
 
 - Fixed getting row counts for SQLite
 
-## [0.2.0] - 2025-06-24
+### v0.2.0 - 2025-06-24
 
-### Added
+#### Added
 
 - SSL support for database connections during configuration
 - Memory feature similar to Claude Code
@@ -256,7 +271,7 @@ All notable changes to SQLsaber will be documented here.
 - Interactive questionary for all user interactions
 - Test suite implementation
 
-### Changed
+#### Changed
 
 - Package renamed from original name to sqlsaber
 - Better configuration handling
@@ -266,20 +281,20 @@ All notable changes to SQLsaber will be documented here.
 - Extracted table display functionality
 - Refactored and cleaned up codebase structure
 
-### Fixed
+#### Fixed
 
 - Fixed list_tables tool functionality
 - Fixed introspect schema tool
 - Fixed minor type checking errors
 - Check before adding new database to prevent duplicates
 
-### Removed
+#### Removed
 
 - Removed write support completely for security
 
-## [0.1.0] - 2025-06-19
+### v0.1.0 - 2025-06-19
 
-### Added
+#### Added
 
 - First working version of SQLSaber
 - Streaming tool response and status messages

sqlsaber-0.19.0/docs/src/content/docs/guides/authentication.mdx

@@ -0,0 +1,135 @@
+---
+title: Authentication
+description: Configure LLM provider authentication for SQLsaber
+---
+
+import { Aside } from '@astrojs/starlight/components';
+
+SQLsaber supports multiple LLM providers.
+
+### Providers
+
+SQLsaber supports the following LLM providers and authentication methods:
+
+- **Anthropic** - API key or Claude Pro/Max subscription
+- **OpenAI** - API key
+- **Google** - API key
+- **Groq** - API key
+- **Mistral** - API key
+- **Cohere** - API key
+- **Hugging Face** - API key
+
+<Aside type="note">
+    API keys and OAuth tokens securely using your operating system's credentials store.
+</Aside>
+
+### Quick Setup
+
+The fastest way to configure authentication:
+
+```bash
+saber auth setup
+```
+
+This interactive command will:
+1. Let you choose your AI provider
+2. Guide you through the authentication process
+3. Securely store your credentials
+
+#### Anthropic
+
+SQLsaber uses Claude Sonnet 4 by default and supports two authentication methods:
+
+##### Claude Pro/Max subscription (Recommended)
+
+> If you have a Claude Pro or Max subscription, you can use it with SQLsaber:
+
+1. Run the setup:
+   ```bash
+   saber auth setup
+   ```
+2. Choose "Anthropic" as your provider
+3. Select "Claude Pro/Max (OAuth)" as the authentication method
+4. Follow the browser-based OAuth flow
+
+##### API Key
+
+1. Get an API key from [Anthropic Console](https://console.anthropic.com/)
+2. Run the setup:
+   ```bash
+   saber auth setup
+   ```
+3. Choose "Anthropic" as your provider
+4. Select "API key" as the authentication method
+5. Enter your API key when prompted
+
+<Aside type="note">
+Follow the same steps for setting up other providers.
+</Aside>
+
+
+### Managing Authentication
+
+#### Check Authentication Status
+
+See which providers are configured:
+
+```bash
+saber auth status
+```
+
+This shows:
+- Currently configured providers
+- Authentication methods (API key vs OAuth)
+
+#### Reset Authentication
+
+To remove stored credentials for a provider:
+
+```bash
+saber auth reset
+```
+
+This will:
+1. Ask you to select which provider to reset
+2. Remove API keys from your OS credentials store
+
+### Multiple Providers
+
+You can configure multiple providers and switch between them when selecting models. Each provider's credentials are stored securely and independently.
+
+### Environment Variables
+
+You can also use environment variables for setting API keys.
+
+Example:
+```bash
+# Anthropic
+export ANTHROPIC_API_KEY="your-api-key"
+
+# OpenAI
+export OPENAI_API_KEY="your-api-key"
+
+# Google
+export GOOGLE_API_KEY="your-api-key"
+```
+
+Environment variables take precedence over stored credentials.
+
+### Getting Help
+
+Check authentication status and configuration:
+
+```bash
+saber auth status
+saber auth --help
+```
+
+### What's Next?
+
+After setting up authentication:
+
+1. [Configure your preferred models](/guides/models)
+2. [Set up database connections](/guides/database-setup)
+3. [Start querying your data](/guides/getting-started)
+4. [Learn about different query modes](/guides/queries)