shotgun-sh 0.1.14.dev2__tar.gz → 0.1.15.dev1__tar.gz

{shotgun_sh-0.1.14.dev2 → shotgun_sh-0.1.15.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shotgun-sh
-Version: 0.1.14.dev2
+Version: 0.1.15.dev1
 Summary: AI-powered research, planning, and task management CLI tool
 Project-URL: Homepage, https://shotgun.sh/
 Project-URL: Repository, https://github.com/shotgun-sh/shotgun

{shotgun_sh-0.1.14.dev2 → shotgun_sh-0.1.15.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shotgun-sh"
-version = "0.1.14.dev2"
+version = "0.1.15.dev1"
 description = "AI-powered research, planning, and task management CLI tool"
 readme = "README.md"
 license = { text = "MIT" }

shotgun_sh-0.1.15.dev1/src/shotgun/cli/feedback.py

@@ -0,0 +1,46 @@
+"""Configuration management CLI commands."""
+
+from typing import Annotated
+
+import typer
+from rich.console import Console
+
+from shotgun.agents.config import get_config_manager
+from shotgun.logging_config import get_logger
+from shotgun.posthog_telemetry import Feedback, FeedbackKind, submit_feedback_survey
+
+logger = get_logger(__name__)
+console = Console()
+
+app = typer.Typer(
+    name="feedback",
+    help="Send us feedback",
+    no_args_is_help=True,
+)
+
+
+@app.callback(invoke_without_command=True)
+def send_feedback(
+    description: Annotated[str, typer.Argument(help="Description of the feedback")],
+    kind: Annotated[
+        FeedbackKind,
+        typer.Option("--type", "-t", help="Feedback type"),
+    ],
+) -> None:
+    """Initialize Shotgun configuration."""
+    config_manager = get_config_manager()
+    config_manager.load()
+    user_id = config_manager.get_user_id()
+
+    if not description:
+        console.print(
+            '❌ Please add your feedback (shotgun feedback "<your feedback>").',
+            style="red",
+        )
+        raise typer.Exit(1)
+
+    feedback = Feedback(kind=kind, description=description, user_id=user_id)
+
+    submit_feedback_survey(feedback)
+
+    console.print("✅ Feedback sent. Thank you!")

{shotgun_sh-0.1.14.dev2 → shotgun_sh-0.1.15.dev1}/src/shotgun/main.py

@@ -16,7 +16,17 @@ from dotenv import load_dotenv
 
 from shotgun import __version__
 from shotgun.agents.config import get_config_manager
-from shotgun.cli import codebase, config, export, plan, research, specify, tasks, update
+from shotgun.cli import (
+    codebase,
+    config,
+    export,
+    feedback,
+    plan,
+    research,
+    specify,
+    tasks,
+    update,
+)
 from shotgun.logging_config import configure_root_logger, get_logger
 from shotgun.posthog_telemetry import setup_posthog_observability
 from shotgun.sentry_telemetry import setup_sentry_observability
@@ -68,6 +78,7 @@ app.add_typer(specify.app, name="specify", help="Generate comprehensive specific
 app.add_typer(tasks.app, name="tasks", help="Generate task lists with agentic approach")
 app.add_typer(export.app, name="export", help="Export artifacts to various formats")
 app.add_typer(update.app, name="update", help="Check for and install updates")
+app.add_typer(feedback.app, name="feedback", help="Send us feedback")
 
 
 def version_callback(value: bool) -> None:

{shotgun_sh-0.1.14.dev2 → shotgun_sh-0.1.15.dev1}/src/shotgun/posthog_telemetry.py

@@ -1,11 +1,14 @@
 """PostHog analytics setup for Shotgun."""
 
+from enum import Enum
 from typing import Any
 
 import posthog
+from pydantic import BaseModel
 
 from shotgun import __version__
 from shotgun.agents.config import get_config_manager
+from shotgun.agents.conversation_manager import ConversationManager
 from shotgun.logging_config import get_early_logger
 
 # Use early logger to prevent automatic StreamHandler creation
@@ -132,3 +135,51 @@ def shutdown() -> None:
             logger.warning("Error shutting down PostHog: %s", e)
         finally:
             _posthog_client = None
+
+
+class FeedbackKind(str, Enum):
+    BUG = "bug"
+    FEATURE = "feature"
+    OTHER = "other"
+
+
+class Feedback(BaseModel):
+    kind: FeedbackKind
+    description: str
+    user_id: str
+
+
+SURVEY_ID = "01999f81-9486-0000-4fa6-9632959f92f3"
+Q_KIND_ID = "aaa5fcc3-88ba-4c24-bcf5-1481fd5efc2b"
+Q_DESCRIPTION_ID = "a0ed6283-5d4b-452c-9160-6768d879db8a"
+
+
+def submit_feedback_survey(feedback: Feedback) -> None:
+    global _posthog_client
+    if _posthog_client is None:
+        logger.debug("PostHog not initialized, skipping feedback survey")
+        return
+
+    config_manager = get_config_manager()
+    config = config_manager.load()
+    conversation_manager = ConversationManager()
+    conversation = conversation_manager.load()
+    last_10_messages = []
+    if conversation is not None:
+        last_10_messages = conversation.get_agent_messages()[:10]
+
+    track_event(
+        "survey sent",
+        properties={
+            "$survey_id": SURVEY_ID,
+            "$survey_questions": [
+                {"id": Q_KIND_ID, "question": "Feedback type"},
+                {"id": Q_DESCRIPTION_ID, "question": "Feedback description"},
+            ],
+            f"$survey_response_{Q_KIND_ID}": feedback.kind,
+            f"$survey_response_{Q_DESCRIPTION_ID}": feedback.description,
+            "provider": config.default_provider.value,
+            "config_version": config.config_version,
+            "last_10_messages": last_10_messages,  # last 10 messages
+        },
+    )

{shotgun_sh-0.1.14.dev2 → shotgun_sh-0.1.15.dev1}/src/shotgun/tui/app.py

@@ -13,6 +13,7 @@ from shotgun.utils.update_checker import perform_auto_update_async
 
 from .screens.chat import ChatScreen
 from .screens.directory_setup import DirectorySetupScreen
+from .screens.feedback import FeedbackScreen
 from .screens.provider_config import ProviderConfigScreen
 
 logger = get_logger(__name__)
@@ -23,10 +24,12 @@ class ShotgunApp(App[None]):
         "chat": ChatScreen,
         "provider_config": ProviderConfigScreen,
         "directory_setup": DirectorySetupScreen,
+        "feedback": FeedbackScreen,
     }
     BINDINGS = [
         Binding("ctrl+c", "quit", "Quit the app"),
     ]
+
     CSS_PATH = "styles.tcss"
 
     def __init__(
@@ -90,7 +93,22 @@ class ShotgunApp(App[None]):
         self.exit()
 
     def get_system_commands(self, screen: Screen[Any]) -> Iterable[SystemCommand]:
-        return []  # we don't want any system commands
+        return [
+            SystemCommand(
+                "Feedback", "Send us feedback or report a bug", self.action_feedback
+            )
+        ]  # we don't want any system commands
+
+    def action_feedback(self) -> None:
+        """Open feedback screen and submit feedback."""
+        from shotgun.posthog_telemetry import Feedback, submit_feedback_survey
+
+        def handle_feedback(feedback: Feedback | None) -> None:
+            if feedback is not None:
+                submit_feedback_survey(feedback)
+                self.notify("✅ Feedback sent. Thank you!")
+
+        self.push_screen("feedback", callback=handle_feedback)
 
 
 def run(no_update_check: bool = False, continue_session: bool = False) -> None:

shotgun_sh-0.1.15.dev1/src/shotgun/tui/screens/feedback.py

@@ -0,0 +1,193 @@
+"""Screen for submitting user feedback."""
+
+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, Label, ListItem, ListView, Static, TextArea
+
+from shotgun.posthog_telemetry import Feedback, FeedbackKind
+
+if TYPE_CHECKING:
+    from ..app import ShotgunApp
+
+
+class FeedbackScreen(Screen[Feedback | None]):
+    """Collect feedback from users."""
+
+    CSS = """
+        FeedbackScreen {
+            layout: vertical;
+        }
+
+        FeedbackScreen > * {
+            height: auto;
+        }
+
+        Label {
+            padding: 0 1;
+        }
+
+        #titlebox {
+            height: auto;
+            margin: 2 0;
+            padding: 1;
+            border: hkey $border;
+            content-align: center middle;
+
+            & > * {
+                text-align: center;
+            }
+        }
+
+        #feedback-title {
+            padding: 1 0;
+            margin-bottom: 2;
+            text-style: bold;
+            color: $text-accent;
+        }
+
+        #feedback-type-list {
+            height: auto;
+            & > * {
+                padding: 1 0;
+            }
+        }
+
+        #feedback-description {
+            margin: 1 0;
+            height: 10;
+            border: solid $border;
+        }
+
+        #feedback-actions {
+            padding: 1;
+        }
+
+        #feedback-actions > * {
+            margin-right: 2;
+        }
+
+        #feedback-type-list {
+            padding: 1;
+        }
+    """
+
+    BINDINGS = [
+        ("escape", "cancel", "Cancel"),
+    ]
+
+    selected_kind: reactive[FeedbackKind] = reactive(FeedbackKind.BUG)
+
+    def compose(self) -> ComposeResult:
+        with Vertical(id="titlebox"):
+            yield Static("Send us feedback", id="feedback-title")
+            yield Static(
+                "Select the type of feedback and provide details below.",
+                id="feedback-summary",
+            )
+        yield ListView(*self._build_feedback_type_items(), id="feedback-type-list")
+        yield TextArea(
+            "",
+            id="feedback-description",
+        )
+        with Horizontal(id="feedback-actions"):
+            yield Button("Submit", variant="primary", id="submit")
+            yield Button("Cancel \\[ESC]", id="cancel")
+
+    def on_mount(self) -> None:
+        list_view = self.query_one(ListView)
+        if list_view.children:
+            list_view.index = 0
+        self.selected_kind = FeedbackKind.BUG
+        text_area = self.query_one("#feedback-description", TextArea)
+        text_area.focus()
+
+    def action_cancel(self) -> None:
+        self.dismiss(None)
+
+    @on(ListView.Highlighted)
+    def _on_kind_highlighted(self, event: ListView.Highlighted) -> None:
+        kind = self._kind_from_item(event.item)
+        if kind:
+            self.selected_kind = kind
+
+    @on(ListView.Selected)
+    def _on_kind_selected(self, event: ListView.Selected) -> None:
+        kind = self._kind_from_item(event.item)
+        if kind:
+            self.selected_kind = kind
+            self.set_focus(self.query_one("#feedback-description", TextArea))
+
+    @on(Button.Pressed, "#submit")
+    def _on_submit_pressed(self) -> None:
+        self._submit_feedback()
+
+    @on(Button.Pressed, "#cancel")
+    def _on_cancel_pressed(self) -> None:
+        self.action_cancel()
+
+    def watch_selected_kind(self, kind: FeedbackKind) -> None:
+        if not self.is_mounted:
+            return
+        # Update the placeholder in text area based on selected kind
+        text_area = self.query_one("#feedback-description", TextArea)
+        text_area.placeholder = self._placeholder_for_kind(kind)
+
+    def _build_feedback_type_items(self) -> list[ListItem]:
+        items: list[ListItem] = []
+        for kind in FeedbackKind:
+            label = Label(self._kind_label(kind), id=f"label-{kind.value}")
+            items.append(ListItem(label, id=f"kind-{kind.value}"))
+        return items
+
+    def _kind_from_item(self, item: ListItem | None) -> FeedbackKind | None:
+        if item is None or item.id is None:
+            return None
+        kind_id = item.id.removeprefix("kind-")
+        try:
+            return FeedbackKind(kind_id)
+        except ValueError:
+            return None
+
+    def _kind_label(self, kind: FeedbackKind) -> str:
+        display_names = {
+            FeedbackKind.BUG: "Bug Report",
+            FeedbackKind.FEATURE: "Feature Request",
+            FeedbackKind.OTHER: "Other",
+        }
+        return display_names.get(kind, kind.value.title())
+
+    def _placeholder_for_kind(self, kind: FeedbackKind) -> str:
+        placeholders = {
+            FeedbackKind.BUG: "Describe the bug you encountered...",
+            FeedbackKind.FEATURE: "Describe the feature you'd like to see...",
+            FeedbackKind.OTHER: "Tell us what's on your mind...",
+        }
+        return placeholders.get(kind, "Enter your feedback...")
+
+    def _submit_feedback(self) -> None:
+        text_area = self.query_one("#feedback-description", TextArea)
+        description = text_area.text.strip()
+
+        if not description:
+            self.notify(
+                "Please enter a description before submitting.", severity="error"
+            )
+            return
+
+        app = cast("ShotgunApp", self.app)
+        user_id = app.config_manager.get_user_id()
+
+        feedback = Feedback(
+            kind=self.selected_kind,
+            description=description,
+            user_id=user_id,
+        )
+
+        self.dismiss(feedback)