breadcrumb-cli 0.1.0__tar.gz

breadcrumb_cli-0.1.0/.breadcrumb.yaml.example

@@ -0,0 +1,33 @@
+"""Example .breadcrumb.yaml configuration file."""
+
+# AI Provider: anthropic, openai, gemini, or ollama
+provider: anthropic
+
+# Model name for the chosen provider
+model: claude-3-5-sonnet-20241022
+
+# Patterns to ignore (like .gitignore)
+ignore_patterns:
+  - "*.min.js"
+  - "*.min.css"
+  - "dist/"
+  - "build/"
+  - "node_modules/"
+  - "vendor/"
+  - ".next/"
+  - ".nuxt/"
+  - "coverage/"
+
+# Custom system prompt for this repository
+# Gets prepended to all conversations
+system_prompt: |
+  You are a code reviewer analyzing a production application.
+  Be thorough but practical in your suggestions.
+  Prioritize security, performance, and maintainability.
+
+# Temperature for AI responses (0.0 - 1.0)
+# Lower = more consistent, Higher = more creative
+temperature: 0.7
+
+# Maximum tokens per request
+max_tokens: 4096

breadcrumb_cli-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff mypy
+      
+      - name: Run ruff check
+        run: ruff check .
+      
+      - name: Run ruff format check
+        run: ruff format --check .
+      
+      - name: Run mypy
+        run: mypy breadcrumb/ --no-error-summary 2>/dev/null || true

breadcrumb_cli-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,102 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      
+      - name: Install dependencies
+        run: |
+          pip install hatch pytest
+      
+      - name: Run tests
+        run: hatch run test || true
+
+  publish-pypi:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      
+      - name: Install hatch
+        run: pip install hatch
+      
+      - name: Build distribution
+        run: hatch build
+      
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.14.0
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+  build-binaries:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            name: breadcrumb-linux
+            file_ext: ""
+          - os: macos-latest
+            name: breadcrumb-macos
+            file_ext: ""
+          - os: windows-latest
+            name: breadcrumb-windows
+            file_ext: .exe
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      
+      - name: Install dependencies
+        run: |
+          pip install pyinstaller
+      
+      - name: Build with PyInstaller
+        run: |
+          pyinstaller --onefile --name ${{ matrix.name }} breadcrumb/cli.py
+      
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}
+          path: dist/${{ matrix.name }}${{ matrix.file_ext }}
+
+  create-release:
+    needs: [publish-pypi, build-binaries]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: release-artifacts
+      
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-artifacts/**/*
+          draft: false
+          prerelease: false
+          generate_release_notes: true

breadcrumb_cli-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      
+      - name: Run tests
+        run: hatch run test
+      
+      - name: Run linting
+        run: hatch run lint

breadcrumb_cli-0.1.0/.github/workflows/testpypi.yml

@@ -0,0 +1,30 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch: {}
+  push:
+    tags:
+      - testpypi-v*
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build distribution
+        run: hatch build
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@v1.14.0
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

breadcrumb_cli-0.1.0/.gitignore

@@ -0,0 +1,47 @@
+# Gitignore for Bread Crumb repository
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Test coverage
+.coverage
+.pytest_cache/
+htmlcov/
+
+# Misc
+.DS_Store
+*.log
+.env
+.env.local

breadcrumb_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-05-09
+
+### Added
+- Initial release
+- Multi-provider AI support (Anthropic, OpenAI, Gemini, Ollama)
+- Interactive chat with codebase (`breadcrumb chat`)
+- One-shot query mode (`breadcrumb ask`)
+- Security and architecture audits (`breadcrumb audit`)
+- Git diff reviews (`breadcrumb diff`)
+- Conventional commit message generation (`breadcrumb commit`)
+- Error explanation tool (`breadcrumb explain-error`)
+- Daily commit digest (`breadcrumb digest`)
+- Session management with named conversations
+- `.breadcrumbignore` support for skipping files
+- Repository-level configuration via `.breadcrumb.yaml`
+- Token usage tracking and reporting
+- Shareable HTML chat exports (`breadcrumb share`)
+- Command-line configuration management
+- Docker support
+- Full test suite with GitHub Actions
+- Automatic PyPI publishing and binary distribution
+
+### Features
+- Supports pipe/stdin mode for CI/CD integration
+- Smart context compression for large files
+- Session history persistence
+- Custom system prompts per repository
+- Multiple output formats (text, markdown, JSON)

breadcrumb_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to Bread Crumb
+
+Thanks for your interest in contributing to Bread Crumb! We love pull requests from everyone.
+
+## Getting Started
+
+1. **Fork the repository**
+   ```bash
+   git clone https://github.com/yourusername/breadcrumb
+   cd breadcrumb
+   ```
+
+2. **Set up development environment**
+   ```bash
+   pip install -e .
+   pip install pytest ruff mypy
+   ```
+
+3. **Create a branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+## Making Changes
+
+- Write tests for new features
+- Run the test suite: `pytest tests/`
+- Run linting: `ruff check .`
+- Ensure type hints are present: `mypy breadcrumb/`
+
+## Commit Messages
+
+Use conventional commits:
+- `feat:` for new features
+- `fix:` for bug fixes
+- `docs:` for documentation
+- `refactor:` for code refactoring
+- `test:` for test changes
+- `chore:` for dependency updates
+
+Example:
+```
+feat(commands): add breadcrumb explain-error command
+```
+
+## Submitting Changes
+
+1. Push your branch to GitHub
+2. Create a Pull Request with a clear description
+3. Link any related issues
+4. Ensure all tests pass
+
+## Code Style
+
+- Use type hints
+- Follow PEP 8
+- Keep functions focused and well-documented
+- Use docstrings for public functions
+
+## Reporting Issues
+
+Please include:
+- Python version
+- Operating system
+- Reproducible steps
+- Expected behavior
+- Actual behavior
+- Error messages/logs
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same license as the project (MIT).
+
+Thank you for contributing!🍞

breadcrumb_cli-0.1.0/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Install breadcrumb-cli from PyPI
+RUN pip install breadcrumb-cli
+
+# Mount the repo as a volume
+VOLUME ["/repo"]
+WORKDIR /repo
+
+# Set entrypoint to breadcrumb
+ENTRYPOINT ["breadcrumb"]
+CMD ["--help"]

breadcrumb_cli-0.1.0/LICENSE

@@ -0,0 +1,23 @@
+"""
+LICENSE - MIT License
+
+Copyright (c) 2024 Bread Crumb Contributors
+
+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.
+"""