shotgun-sh 0.2.8.dev2__py3-none-any.whl → 0.3.3.dev1__py3-none-any.whl

shotgun/agents/common.py

@@ -4,6 +4,7 @@ from collections.abc import Callable
 from pathlib import Path
 from typing import Any
 
+import aiofiles
 from pydantic_ai import (
     Agent,
     RunContext,
@@ -24,7 +25,7 @@ from shotgun.utils import ensure_shotgun_directory_exists
 from shotgun.utils.datetime_utils import get_datetime_context
 from shotgun.utils.file_system_utils import get_shotgun_base_path
 
-from .history import token_limit_compactor
+from .conversation.history import token_limit_compactor
 from .messages import AgentSystemPrompt, SystemStatusPrompt
 from .models import AgentDeps, AgentRuntimeOptions, PipelineConfigEntry
 from .tools import (
@@ -68,7 +69,7 @@ async def add_system_status_message(
     existing_files = get_agent_existing_files(deps.agent_mode)
 
     # Extract table of contents from the agent's markdown file
-    markdown_toc = extract_markdown_toc(deps.agent_mode)
+    markdown_toc = await extract_markdown_toc(deps.agent_mode)
 
     # Get current datetime with timezone information
     dt_context = get_datetime_context()
@@ -94,7 +95,7 @@ async def add_system_status_message(
     return message_history
 
 
-def create_base_agent(
+async def create_base_agent(
     system_prompt_fn: Callable[[RunContext[AgentDeps]], str],
     agent_runtime_options: AgentRuntimeOptions,
     load_codebase_understanding_tools: bool = True,
@@ -119,7 +120,7 @@ def create_base_agent(
 
     # Get configured model or fall back to first available provider
     try:
-        model_config = get_provider_model(provider)
+        model_config = await get_provider_model(provider)
         provider_name = model_config.provider
         logger.debug(
             "🤖 Creating agent with configured %s model: %s",
@@ -194,7 +195,7 @@ def create_base_agent(
     return agent, deps
 
 
-def _extract_file_toc_content(
+async def _extract_file_toc_content(
     file_path: Path, max_depth: int | None = None, max_chars: int = 500
 ) -> str | None:
     """Extract TOC from a single file with depth and character limits.
@@ -211,7 +212,8 @@ def _extract_file_toc_content(
         return None
 
     try:
-        content = file_path.read_text(encoding="utf-8")
+        async with aiofiles.open(file_path, encoding="utf-8") as f:
+            content = await f.read()
         lines = content.split("\n")
 
         # Extract headings
@@ -257,7 +259,7 @@ def _extract_file_toc_content(
         return None
 
 
-def extract_markdown_toc(agent_mode: AgentType | None) -> str | None:
+async def extract_markdown_toc(agent_mode: AgentType | None) -> str | None:
     """Extract TOCs from current and prior agents' files in the pipeline.
 
     Shows full TOC of agent's own file and high-level summaries of prior agents'
@@ -309,7 +311,9 @@ def extract_markdown_toc(agent_mode: AgentType | None) -> str | None:
     for prior_file in config.prior_files:
         file_path = base_path / prior_file
         # Only show # and ## headings from prior files, max 500 chars each
-        prior_toc = _extract_file_toc_content(file_path, max_depth=2, max_chars=500)
+        prior_toc = await _extract_file_toc_content(
+            file_path, max_depth=2, max_chars=500
+        )
         if prior_toc:
             # Add section with XML tags
             toc_sections.append(
@@ -321,7 +325,9 @@ def extract_markdown_toc(agent_mode: AgentType | None) -> str | None:
     # Extract TOC from own file (full detail)
     if config.own_file:
         own_path = base_path / config.own_file
-        own_toc = _extract_file_toc_content(own_path, max_depth=None, max_chars=2000)
+        own_toc = await _extract_file_toc_content(
+            own_path, max_depth=None, max_chars=2000
+        )
         if own_toc:
             # Put own file TOC at the beginning with XML tags
             toc_sections.insert(

shotgun/agents/config/README.md

@@ -0,0 +1,89 @@
+# Configuration Management
+
+This directory contains the configuration management system for Shotgun, including models, migrations, and provider integration.
+
+## Config Version History
+
+### Version 1 (Config Versioning Introduced)
+
+- **Commit**: `f36defc` (Sep 19, 2025)
+- **Title**: "feat: add Sentry error tracking with anonymous user identification"
+- **Key Fields**: `user_id`, `config_version: 1`
+- **Note**: First version to include explicit versioning
+
+### Version 2 (Shotgun Account Provider)
+
+- **Commit**: `37a5add` (Oct 3, 2025)
+- **Title**: "feat: add Shotgun Account provider with LiteLLM proxy support"
+- **Key Fields**: `user_id`, `config_version: 2`, added `shotgun` provider config
+- **Note**: Configs without a version field default to v2 during migration
+
+### Version 3 (OAuth Authentication)
+
+- **Commit**: `39d2af9` (Oct 6, 2025)
+- **Title**: "feat: implement OAuth-style authentication flow for Shotgun Account"
+- **Key Changes**:
+  - Renamed `user_id` → `shotgun_instance_id`
+  - Added `supabase_jwt` field to Shotgun Account config
+- **Git Tags**: Both `0.2.11.dev1` and `0.2.11.dev2` are at this version
+
+### Version 4 (Marketing Messages)
+
+- **Commit**: `8638a6d` (Nov 4, 2025)
+- **Title**: "feat: add marketing message system for GitHub star promotion"
+- **Key Changes**:
+  - Added `marketing` configuration with message tracking
+  - Added `shown_welcome_screen` field (set to `False` for existing BYOK users)
+
+### Version 5 (Streaming Detection) - CURRENT
+
+- **Commit**: `fded351` (Nov 6, 2025)
+- **Title**: "feat: add config migration for streaming capability field (v4->v5)"
+- **Key Changes**:
+  - Added `supports_streaming` field to OpenAI config
+  - Added `shown_onboarding_popup` timestamp field
+  - Added `supabase_jwt` to Shotgun Account config
+
+## Migration System
+
+The migration system is designed to be sequential and idempotent. Migrations are defined in `manager.py`:
+
+- `_migrate_v2_to_v3()`: Renames `user_id` to `shotgun_instance_id`
+- `_migrate_v3_to_v4()`: Adds marketing config and welcome screen flag
+- `_migrate_v4_to_v5()`: Adds streaming support fields
+
+All migrations preserve user data (API keys, settings) and can be safely run multiple times.
+
+## Adding a New Config Version
+
+When adding a new config version:
+
+1. **Update `models.py`**:
+   - Increment `CURRENT_CONFIG_VERSION` constant
+   - Add new fields to appropriate config models
+
+2. **Create migration function in `manager.py`**:
+   ```python
+   def _migrate_vN_to_vN+1(data: dict[str, Any]) -> dict[str, Any]:
+       """Migrate config from version N to N+1."""
+       data["config_version"] = N + 1
+       # Add migration logic
+       return data
+   ```
+
+3. **Register migration**:
+   - Add to `migrations` dict in `_apply_migrations()`
+
+4. **Add tests in `test/unit/test_config_migrations.py`**:
+   - Create example config for version N
+   - Test individual migration function
+   - Test sequential migration from version N to current
+   - Test with populated configs (non-empty API keys, etc.)
+   - Test edge cases
+
+## Files
+
+- **`models.py`**: Pydantic models for configuration schema
+- **`manager.py`**: ConfigManager class and migration functions
+- **`provider.py`**: LLM provider integration and model creation
+- **`streaming_test.py`**: OpenAI streaming capability detection

shotgun/agents/config/__init__.py

@@ -1,11 +1,20 @@
 """Configuration module for Shotgun CLI."""
 
-from .manager import ConfigManager, get_config_manager
+from .manager import (
+    BACKUP_DIR_NAME,
+    ConfigManager,
+    ConfigMigrationError,
+    get_backup_dir,
+    get_config_manager,
+)
 from .models import ProviderType, ShotgunConfig
 from .provider import get_provider_model
 
 __all__ = [
+    "BACKUP_DIR_NAME",
     "ConfigManager",
+    "ConfigMigrationError",
+    "get_backup_dir",
     "get_config_manager",
     "ProviderType",
     "ShotgunConfig",

shotgun/agents/config/constants.py

@@ -24,11 +24,5 @@ ANTHROPIC_PROVIDER = ConfigSection.ANTHROPIC.value
 GOOGLE_PROVIDER = ConfigSection.GOOGLE.value
 SHOTGUN_PROVIDER = ConfigSection.SHOTGUN.value
 
-# Environment variable names
-OPENAI_API_KEY_ENV = "OPENAI_API_KEY"
-ANTHROPIC_API_KEY_ENV = "ANTHROPIC_API_KEY"
-GEMINI_API_KEY_ENV = "GEMINI_API_KEY"
-SHOTGUN_API_KEY_ENV = "SHOTGUN_API_KEY"
-
 # Token limits
 MEDIUM_TEXT_8K_TOKENS = 8192  # Default max_tokens for web search requests