shotgun-sh 0.1.0__tar.gz

shotgun_sh-0.1.0/.gitignore

@@ -0,0 +1,212 @@
+# Temp directory
+tmp/
+
+# Playground
+playground/
+
+# Output directory
+.shotgun/
+
+# Generated build files
+src/shotgun/build_constants.py
+
+# Claude code
+./claude/.claude/settings.local.json
+
+.DS_Store
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode

shotgun_sh-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Proofs.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shotgun_sh-0.1.0/PKG-INFO

@@ -0,0 +1,466 @@
+Metadata-Version: 2.4
+Name: shotgun-sh
+Version: 0.1.0
+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
+Project-URL: Issues, https://github.com/shotgun-sh/shotgun-alpha/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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.39.0
+Requires-Dist: google-generativeai>=0.8.5
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: kuzu>=0.7.0
+Requires-Dist: logfire[pydantic-ai]>=2.0.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: posthog>=3.0.0
+Requires-Dist: pydantic-ai>=0.0.14
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sentry-sdk[pure-eval]>=2.0.0
+Requires-Dist: textual-dev>=1.7.0
+Requires-Dist: textual>=6.1.0
+Requires-Dist: tiktoken>=0.7.0
+Requires-Dist: tree-sitter-go>=0.23.0
+Requires-Dist: tree-sitter-javascript>=0.23.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"
+```
+
+## Auto-Updates
+
+Shotgun automatically checks for updates to keep you on the latest version.
+
+### How it works
+
+- Checks for updates on startup (runs in background, non-blocking)
+- Caches results for 24 hours to minimize API calls
+- Shows notification after command execution if an update is available
+- Never auto-updates development versions
+
+### Update Commands
+
+```bash
+# Check for available updates
+shotgun update --check
+
+# Install available updates
+shotgun update
+
+# Force update (even for dev versions with confirmation)
+shotgun update --force
+```
+
+### Disable Update Checks
+
+```bash
+# Disable for a single command
+shotgun --no-update-check research "topic"
+```
+
+### Installation Methods
+
+The update command automatically detects and uses the appropriate method:
+- **pipx**: `pipx upgrade shotgun-sh`
+- **pip**: `pip install --upgrade shotgun-sh`
+- **venv**: Updates within the virtual environment
+
+## Development Setup
+
+### Requirements
+
+- **Python 3.11+** (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.11+**. The `.python-version` file specifies Python 3.11 to ensure development against the minimum supported version.
+
+If using **pyenv**:
+```bash
+pyenv install 3.11
+```
+
+If using **uv** (recommended):
+```bash
+uv python install 3.11
+uv sync --python 3.11
+```
+
+### 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.11
+- Validates code with ruff, ruff-format, and mypy
+- Ensures all checks pass before merge
+
+## Observability & Telemetry
+
+Shotgun includes built-in observability with Sentry for error tracking and Logfire for logging and tracing. Both services track users anonymously using a UUID generated on first run.
+
+### Anonymous User Tracking
+
+Each user gets a unique anonymous ID stored in their config:
+```bash
+# Get your anonymous user ID
+shotgun config get-user-id
+```
+
+This ID is automatically included in:
+- **Sentry**: Error reports and exceptions
+- **Logfire**: All logs, traces, and spans
+
+### Logfire Queries
+
+Logfire uses SQL for querying logs. Here are helpful queries for debugging and analysis:
+
+#### Find all logs for a specific user
+```sql
+SELECT * FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+ORDER BY timestamp DESC;
+```
+
+#### Track user actions
+```sql
+SELECT
+  timestamp,
+  span_name,
+  message,
+  attributes
+FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+  AND span_name LIKE '%research%'
+ORDER BY timestamp DESC;
+```
+
+#### Find slow operations for a user
+```sql
+SELECT
+  span_name,
+  duration_ms,
+  attributes
+FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+  AND duration_ms > 1000
+ORDER BY duration_ms DESC;
+```
+
+#### Find errors for a user
+```sql
+SELECT * FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+  AND level = 'error'
+ORDER BY timestamp DESC;
+```
+
+#### Analyze user's AI provider usage
+```sql
+SELECT
+  attributes->>'provider' as provider,
+  COUNT(*) as usage_count,
+  AVG(duration_ms) as avg_duration
+FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+  AND attributes->>'provider' IS NOT NULL
+GROUP BY provider;
+```
+
+#### Track feature usage by user
+```sql
+SELECT
+  span_name,
+  COUNT(*) as usage_count
+FROM records
+WHERE attributes->>'user_id' = 'your-user-id-here'
+  AND span_name IN ('research', 'plan', 'tasks')
+GROUP BY span_name
+ORDER BY usage_count DESC;
+```
+
+### Setting Up Observability (Optional)
+
+For local development with Logfire:
+```bash
+# Set environment variables
+export LOGFIRE_ENABLED=true
+export LOGFIRE_TOKEN=your-logfire-token
+
+# Run shotgun - will now send logs to Logfire
+shotgun research "topic"
+```
+
+For Sentry (automatically configured in production builds):
+```bash
+# Set for local development
+export SENTRY_DSN=your-sentry-dsn
+```
+
+### Privacy
+
+- **No PII collected**: Only anonymous UUIDs are used for identification
+- **Opt-in for development**: Telemetry requires explicit environment variables
+- **Automatic in production**: Production builds include telemetry for error tracking
+
+## Support
+
+Join our discord https://discord.gg/5RmY6J2N7s