shotgun-sh 0.1.0.dev1__py3-none-any.whl

shotgun/tui/screens/provider_config.py

@@ -0,0 +1,221 @@
+"""Screen for configuring provider API keys before entering chat."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, cast
+
+from textual import on
+from textual.app import ComposeResult
+from textual.containers import Horizontal, Vertical
+from textual.reactive import reactive
+from textual.screen import Screen
+from textual.widgets import Button, Input, Label, ListItem, ListView, Static
+
+from shotgun.agents.config import ConfigManager, ProviderType
+
+if TYPE_CHECKING:
+    from ..app import ShotgunApp
+
+
+class ProviderConfigScreen(Screen[None]):
+    """Collect API keys for available providers."""
+
+    CSS = """
+        ProviderConfig {
+            layout: vertical;
+        }
+
+        ProviderConfig > * {
+            height: auto;
+        }
+
+        #titlebox {
+            height: auto;
+            margin: 2 0;
+            padding: 1;
+            border: hkey $border;
+            content-align: center middle;
+
+            & > * {
+                text-align: center;
+            }
+        }
+
+        #provider-config-title {
+            padding: 1 0;
+            text-style: bold;
+            color: $text-accent;
+        }
+
+        #provider-list {
+            margin: 2 0;
+            height: auto;
+            & > * {
+            padding: 1 0;
+            }
+        }
+        #provider-actions {
+            padding: 1;
+        }
+        #provider-actions > * {
+        margin-right: 2;
+        }
+        #provider-list {
+            padding: 1;
+        }
+    """
+
+    BINDINGS = [
+        ("escape", "done", "Back"),
+    ]
+
+    selected_provider: reactive[ProviderType] = reactive(ProviderType.OPENAI)
+
+    def compose(self) -> ComposeResult:
+        with Vertical(id="titlebox"):
+            yield Static("Provider setup", id="provider-config-title")
+            yield Static(
+                "Select a provider and enter the API key needed to activate it.",
+                id="provider-config-summary",
+            )
+        yield ListView(*self._build_provider_items(), id="provider-list")
+        yield Input(
+            placeholder=self._input_placeholder(self.selected_provider),
+            password=True,
+            id="api-key",
+        )
+        with Horizontal(id="provider-actions"):
+            yield Button("Save key \\[ENTER]", variant="primary", id="save")
+            yield Button("Clear key", id="clear", variant="warning")
+            yield Button("Done \\[ESC]", id="done")
+
+    def on_mount(self) -> None:
+        self.refresh_provider_status()
+        list_view = self.query_one(ListView)
+        if list_view.children:
+            list_view.index = 0
+        self.selected_provider = ProviderType.OPENAI
+        self.set_focus(self.query_one("#api-key", Input))
+
+    def action_done(self) -> None:
+        self.dismiss()
+
+    @on(ListView.Highlighted)
+    def _on_provider_highlighted(self, event: ListView.Highlighted) -> None:
+        provider = self._provider_from_item(event.item)
+        if provider:
+            self.selected_provider = provider
+
+    @on(ListView.Selected)
+    def _on_provider_selected(self, event: ListView.Selected) -> None:
+        provider = self._provider_from_item(event.item)
+        if provider:
+            self.selected_provider = provider
+            self.set_focus(self.query_one("#api-key", Input))
+
+    @on(Button.Pressed, "#save")
+    def _on_save_pressed(self) -> None:
+        self._save_api_key()
+
+    @on(Button.Pressed, "#clear")
+    def _on_clear_pressed(self) -> None:
+        self._clear_api_key()
+
+    @on(Button.Pressed, "#done")
+    def _on_done_pressed(self) -> None:
+        self.action_done()
+
+    @on(Input.Submitted, "#api-key")
+    def _on_input_submitted(self, event: Input.Submitted) -> None:
+        del event  # unused
+        self._save_api_key()
+
+    def watch_selected_provider(self, provider: ProviderType) -> None:
+        if not self.is_mounted:
+            return
+        input_widget = self.query_one("#api-key", Input)
+        input_widget.placeholder = self._input_placeholder(provider)
+        input_widget.value = ""
+
+    @property
+    def config_manager(self) -> ConfigManager:
+        app = cast("ShotgunApp", self.app)
+        return app.config_manager
+
+    def refresh_provider_status(self) -> None:
+        """Update the list view entries to reflect configured providers."""
+        for provider in ProviderType:
+            label = self.query_one(f"#label-{provider.value}", Label)
+            label.update(self._provider_label(provider))
+
+    def _build_provider_items(self) -> list[ListItem]:
+        items: list[ListItem] = []
+        for provider in ProviderType:
+            label = Label(self._provider_label(provider), id=f"label-{provider.value}")
+            items.append(ListItem(label, id=f"provider-{provider.value}"))
+        return items
+
+    def _provider_from_item(self, item: ListItem | None) -> ProviderType | None:
+        if item is None or item.id is None:
+            return None
+        provider_id = item.id.removeprefix("provider-")
+        try:
+            return ProviderType(provider_id)
+        except ValueError:
+            return None
+
+    def _provider_label(self, provider: ProviderType) -> str:
+        display = self._provider_display_name(provider)
+        status = (
+            "Configured"
+            if self.config_manager.has_provider_key(provider)
+            else "Not configured"
+        )
+        return f"{display} · {status}"
+
+    def _provider_display_name(self, provider: ProviderType) -> str:
+        names = {
+            ProviderType.OPENAI: "OpenAI",
+            ProviderType.ANTHROPIC: "Anthropic",
+            ProviderType.GOOGLE: "Google Gemini",
+        }
+        return names.get(provider, provider.value.title())
+
+    def _input_placeholder(self, provider: ProviderType) -> str:
+        return f"{self._provider_display_name(provider)} API key"
+
+    def _save_api_key(self) -> None:
+        input_widget = self.query_one("#api-key", Input)
+        api_key = input_widget.value.strip()
+
+        if not api_key:
+            self.notify("Enter an API key before saving.", severity="error")
+            return
+
+        try:
+            self.config_manager.update_provider(
+                self.selected_provider,
+                api_key=api_key,
+            )
+        except Exception as exc:  # pragma: no cover - defensive; textual path
+            self.notify(f"Failed to save key: {exc}", severity="error")
+            return
+
+        input_widget.value = ""
+        self.refresh_provider_status()
+        self.notify(
+            f"Saved API key for {self._provider_display_name(self.selected_provider)}."
+        )
+
+    def _clear_api_key(self) -> None:
+        try:
+            self.config_manager.clear_provider_key(self.selected_provider)
+        except Exception as exc:  # pragma: no cover - defensive; textual path
+            self.notify(f"Failed to clear key: {exc}", severity="error")
+            return
+
+        self.refresh_provider_status()
+        self.query_one("#api-key", Input).value = ""
+        self.notify(
+            f"Cleared API key for {self._provider_display_name(self.selected_provider)}."
+        )

shotgun/tui/screens/splash.py

@@ -0,0 +1,31 @@
+from textual.app import ComposeResult
+from textual.containers import Container
+from textual.screen import Screen
+
+from ..components.splash import SplashWidget
+
+
+class SplashScreen(Screen[None]):
+    CSS = """
+        #splash-container {
+            align: center middle;
+            width: 100%;
+            height: 100%;
+
+        }
+
+        SplashWidget {
+            color: $text-accent;
+        }
+    """
+    """Splash screen for the app."""
+
+    def on_mount(self) -> None:
+        self.set_timer(2, self.on_timer_tick)
+
+    def on_timer_tick(self) -> None:
+        self.dismiss()
+
+    def compose(self) -> ComposeResult:
+        with Container(id="splash-container"):
+            yield SplashWidget()

shotgun/tui/styles.tcss

@@ -0,0 +1,10 @@
+Screen {
+  background: $surface;
+}
+
+Input {
+  border: round $border-blurred;
+  &:focus {
+    border: round $border;
+  }
+}

shotgun/utils/__init__.py

@@ -0,0 +1,5 @@
+"""Utility functions for the Shotgun package."""
+
+from .file_system_utils import ensure_shotgun_directory_exists, get_shotgun_home
+
+__all__ = ["ensure_shotgun_directory_exists", "get_shotgun_home"]

shotgun/utils/file_system_utils.py

@@ -0,0 +1,31 @@
+"""File system utility functions."""
+
+import os
+from pathlib import Path
+
+
+def get_shotgun_home() -> Path:
+    """Get the Shotgun home directory path.
+
+    Can be overridden with SHOTGUN_HOME environment variable for testing.
+
+    Returns:
+        Path to shotgun home directory (default: ~/.shotgun-sh/)
+    """
+    # Allow override via environment variable (useful for testing)
+    if custom_home := os.environ.get("SHOTGUN_HOME"):
+        return Path(custom_home)
+
+    return Path.home() / ".shotgun-sh"
+
+
+def ensure_shotgun_directory_exists() -> Path:
+    """Ensure the .shotgun directory exists and return its path.
+
+    Returns:
+        Path: The path to the .shotgun directory.
+    """
+    shotgun_dir = Path.cwd() / ".shotgun"
+    shotgun_dir.mkdir(exist_ok=True)
+    # Note: Removed logger to avoid circular dependency with logging_config
+    return shotgun_dir

shotgun_sh-0.1.0.dev1.dist-info/METADATA

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: shotgun-sh
+Version: 0.1.0.dev1
+Summary: AI-powered research, planning, and task management CLI tool
+Project-URL: Homepage, https://github.com/shotgun-sh/shotgun
+Project-URL: Repository, https://github.com/shotgun-sh/shotgun
+Project-URL: Issues, https://github.com/shotgun-sh/shotgun/issues
+Project-URL: Discord, https://discord.gg/5RmY6J2N7s
+Author-email: "Proofs.io" <hello@proofs.io>
+License: MIT
+License-File: LICENSE
+Keywords: agent,ai,cli,llm,planning,productivity,pydantic-ai,research,task-management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: kuzu>=0.7.0
+Requires-Dist: openinference-instrumentation-pydantic-ai
+Requires-Dist: opentelemetry-api
+Requires-Dist: opentelemetry-exporter-otlp
+Requires-Dist: opentelemetry-sdk
+Requires-Dist: pydantic-ai>=0.0.14
+Requires-Dist: rich>=13.0.0
+Requires-Dist: textual-dev>=1.7.0
+Requires-Dist: textual>=6.1.0
+Requires-Dist: tree-sitter-go>=0.23.0
+Requires-Dist: tree-sitter-javascript>=0.23.0
+Requires-Dist: tree-sitter-languages>=1.10.0
+Requires-Dist: tree-sitter-python>=0.23.0
+Requires-Dist: tree-sitter-rust>=0.23.0
+Requires-Dist: tree-sitter-typescript>=0.23.0
+Requires-Dist: tree-sitter>=0.21.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: dev
+Requires-Dist: commitizen>=3.13.0; extra == 'dev'
+Requires-Dist: lefthook>=1.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.11.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Shotgun
+
+A Python CLI tool for research, planning, and task management powered by AI agents.
+
+## Features
+
+- **Research**: Perform research with agentic loops
+- **Planning**: Generate structured plans for achieving goals
+- **Tasks**: Generate prioritized task lists with agentic approaches
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install shotgun-sh
+```
+
+### From Source
+
+```bash
+git clone https://github.com/shotgun-sh/shotgun.git
+cd shotgun
+uv sync --all-extras
+```
+
+After installation from source, you can use either method:
+
+**Method 1: Direct command (after uv sync)**
+```bash
+shotgun --help
+```
+
+**Method 2: Via uv run**
+```bash
+uv run shotgun --help
+```
+
+If installed from PyPI, simply use:
+```bash
+shotgun --help
+```
+
+### Virtual Environment Setup (Optional)
+
+If you prefer using a local virtual environment:
+
+```bash
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv sync --all-extras
+shotgun --help
+```
+
+## Usage
+
+### Using Direct Commands (after uv sync)
+
+```bash
+# Research a topic
+shotgun research "What is quantum computing?"
+
+# Generate a plan
+shotgun plan "Build a web application"
+shotgun plan "build me a house"
+
+# Generate tasks for a project
+shotgun tasks "Create a machine learning model"
+```
+
+### Using uv run
+
+```bash
+# Research a topic
+uv run shotgun research "What is quantum computing?"
+
+# Generate a plan
+uv run shotgun plan "Build a web application"
+
+# Generate tasks for a project
+uv run shotgun tasks "Create a machine learning model"
+```
+
+## Development Setup
+
+### Requirements
+
+- **Python 3.10+** (3.13 recommended)
+- **uv** - Fast Python package installer and resolver
+- **actionlint** (optional) - For GitHub Actions workflow validation
+
+### Quick Start
+
+1. **Clone and setup**:
+   ```bash
+   git clone https://github.com/shotgun-sh/shotgun.git
+   cd shotgun
+   ```
+
+2. **Install uv** (if not already installed):
+   ```bash
+   # macOS/Linux
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   
+   # Or via brew
+   brew install uv
+   ```
+
+3. **Install dependencies**:
+   ```bash
+   uv sync --all-extras
+   ```
+
+4. **Install git hooks**:
+   ```bash
+   uv run lefthook install
+   ```
+
+5. **Verify setup**:
+   ```bash
+   uv run shotgun --version
+   ```
+
+### Development Commands
+
+```bash
+# Run the CLI
+uv run shotgun --help
+
+# Run the TUI
+uv run tui
+
+# Run tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=src --cov-report=term-missing --cov-report=html
+
+# Run linting
+uv run ruff check .
+
+# Run formatting
+uv run ruff format .
+
+# Run type checking
+uv run mypy src/
+
+# Run all pre-commit hooks manually
+uv run lefthook run pre-commit
+```
+
+### Code Coverage
+
+To analyze test coverage and identify areas that need testing:
+
+```bash
+# Run tests with coverage analysis
+uv run pytest --cov=src --cov-report=term-missing --cov-report=html
+```
+
+This will:
+- Display coverage summary in the terminal
+- Generate a detailed HTML coverage report
+
+**Viewing the coverage report:**
+Open `htmlcov/index.html` in your browser to see:
+- Overall coverage percentage
+- File-by-file coverage breakdown  
+- Line-by-line coverage highlighting
+- Missing coverage areas
+
+The coverage configuration is in `pyproject.toml` and will automatically run when you use `uv run pytest`.
+
+### Git Hooks (Lefthook)
+
+This project uses [lefthook](https://github.com/evilmartians/lefthook) for git hooks. The hooks automatically run:
+
+- **ruff** - Python linting with auto-fix
+- **ruff-format** - Code formatting  
+- **mypy** - Type checking
+- **commitizen** - Commit message validation
+- **actionlint** - GitHub Actions workflow validation (if installed)
+
+#### Installing actionlint (recommended)
+
+```bash
+# macOS
+brew install actionlint
+
+# Linux/macOS (direct download)
+curl -sSfL https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash | bash
+
+# Go install
+go install github.com/rhysd/actionlint/cmd/actionlint@latest
+```
+
+
+### Python Version Management
+
+The project supports **Python 3.10+**. The `.python-version` file specifies Python 3.10 to ensure development against the minimum supported version.
+
+If using **pyenv**:
+```bash
+pyenv install 3.10.16  # or latest 3.10.x
+```
+
+If using **uv** (recommended):
+```bash
+uv python install 3.10
+uv sync --python 3.10
+```
+
+### Commit Message Convention
+
+This project enforces **Conventional Commits** specification. All commit messages must follow this format:
+
+```
+<type>[optional scope]: <description>
+```
+
+**Required commit types:**
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code formatting changes
+- `refactor`: Code restructuring without feature changes
+- `perf`: Performance improvements
+- `test`: Adding or updating tests
+- `build`: Build system changes
+- `ci`: CI/CD changes
+- `chore`: Maintenance tasks
+- `revert`: Reverting previous commits
+
+**Examples:**
+```bash
+feat: add user authentication system
+fix: resolve memory leak in data processing
+docs: update API documentation
+refactor: simplify user validation logic
+```
+
+**For interactive commit creation:**
+```bash
+uv run cz commit
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feat/feature-name`
+3. Make your changes
+4. Run the pre-commit hooks: `uv run lefthook run pre-commit`
+5. Commit with conventional format: `git commit -m "feat: add new feature"`
+6. Push to your fork: `git push origin feat/feature-name`
+7. Create a Pull Request with conventional title format
+
+### CI/CD
+
+GitHub Actions automatically:
+- Runs on pull requests and pushes to main
+- Tests with Python 3.10
+- Validates code with ruff, ruff-format, and mypy
+- Ensures all checks pass before merge
+
+## Support
+
+Join our discord https://discord.gg/5RmY6J2N7s