henchman-ai 0.1.12__tar.gz → 0.1.14__tar.gz

henchman_ai-0.1.14/.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+    paths: ['docs/**', 'mkdocs.yml', 'README.md']
+  pull_request:
+    branches: [ main ]
+    paths: ['docs/**', 'mkdocs.yml', 'README.md']
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-autorefs
+
+      - name: Build documentation
+        run: mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

henchman_ai-0.1.14/BETA_TESTING_ISSUES3.md

@@ -0,0 +1,35 @@
+1.  **Esc should immediately halt processing and return to the prompt.**
+    *   **Fix:** `Repl.run()` was updated to distinguish between `KeyboardInterrupt` (Ctrl+C, which exits the REPL) and `KeyMonitor.stop_requested` (Esc key, which interrupts the current agent operation and returns to the prompt). Related tests were refactored to simulate Esc using `monitor.stop_requested = True` in `_run_agent`.
+
+2.  **Web Search Tool Integration.**
+    *   **Fix:** Integrated `DuckDuckGoSearchTool` using `aiohttp` and `beautifulsoup4` to provide web search functionality. `pyproject.toml` was updated with the new dependency.
+
+3.  **UI Issues - Input prompt writes over output.**
+    *   **Fix:** Added `self.console.print()` before `prompt_async` in `_get_input` within `src/henchman/cli/repl.py` to ensure the prompt always appears on a new line.
+
+4.  **UI Issues - Bottom bar disappears.**
+    *   **Fix:** Implemented `_get_rich_status_message` and integrated it with `rich.status.Status` in `_run_agent` and `_process_agent_stream` to maintain a persistent status bar during agent processing.
+
+5.  **Loading sessions does not work correctly.**
+    *   **Fix:** Modified the `load` method in `src/henchman/core/session.py` to support loading sessions by ID prefix in addition to exact UUIDs, enabling resumption with truncated IDs displayed in `/chat list`.
+
+6.  **Functional testing of the `/plan` tool.**
+    *   **Fix:** An E2E test (`tests/e2e/test_plan_mode_workflow.py`) was added to verify `/plan` command behavior, ensuring writes are blocked/allowed correctly based on plan mode status. The `test_cli_plan_flag` assertion was updated to reflect the new `_run_interactive` signature.
+
+7.  **Tool execution - Shell commands hanging indefinitely.**
+    *   **Fix:** Added `asyncio.CancelledError` handling to `ShellTool.execute` to ensure subprocesses are killed if the shell tool execution is interrupted. Tests were added (`tests/tools/test_shell_advanced.py`) to verify shell tool handling of pipes, redirection, and timeouts.
+
+8.  **`AttributeError: 'Repl' object has no attribute '_get_rich_status'` failures.**
+    *   **Fix:** This was primarily a Python import caching issue after refactoring `_get_rich_status` to `_get_rich_status_message`. Clearing `__pycache__` directories resolved the widespread `AttributeError`s.
+
+9.  **`OSError: pytest: reading from stdin while output is captured!` in tool execution tests.**
+    *   **Fix:** Modified relevant test setups in `tests/e2e/test_tool_fix.py` and `tests/ui_integration/test_tool_calls.py` to set `repl.config.auto_approve_tools = True`, preventing interactive confirmation prompts during automated testing.
+
+10. **`test_version.py::test_version_tuple` version mismatch.**
+    *   **Fix:** Updated the expected version tuple in `tests/test_version.py` from `(0, 1, 11)` to `(0, 1, 13)` to align with the current project version.
+
+11. **`test_rag_command.py::TestRagCommand::test_reindex_with_rag_system` failure.**
+    *   **Fix:** Corrected the mocking logic in the test to ensure `mock_repl.rag_system.index` was properly configured and its `is_indexing` attribute was set to `False`, allowing the `index` method to be called and asserted.
+
+12. **`test_loop_protection.py::TestSpinningDetection::test_consecutive_duplicate_detection` failure.**
+    *   **Fix:** Modified the test case to use a non-read-only tool (`write_file`) and increased the number of calls to correctly trigger the consecutive duplicate detection logic within `TurnState.is_spinning()`.

{henchman_ai-0.1.12 → henchman_ai-0.1.14}/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.14] - 2025-02-12
+
+### Added
+- **Enhanced PyPI Documentation**
+  - Improved README.md with badges, better structure, and detailed examples
+  - Added comprehensive CONTRIBUTING.md guide for contributors
+  - Updated project metadata with better classifiers and documentation URLs
+  - Added local documentation build script for offline viewing
+
+### Changed
+- **Project Metadata**
+  - Updated pyproject.toml with additional Python version classifiers
+  - Added more specific topic classifiers (AI, Scientific/Engineering)
+  - Enhanced project URLs with better documentation links
+
+### Fixed
+- **Documentation**
+  - Fixed documentation URLs to point to GitHub docs directory
+  - Improved installation and usage instructions in README
+
 ## [0.1.11] - 2026-01-30
 
 ### Fixed

henchman_ai-0.1.14/CONTRIBUTING.md

@@ -0,0 +1,220 @@
+# Contributing to Henchman-AI
+
+Thank you for your interest in contributing to Henchman-AI! This document provides guidelines and instructions for contributing.
+
+## 🎯 How to Contribute
+
+### 1. Reporting Bugs
+- Check if the bug has already been reported in [Issues](https://github.com/MGPowerlytics/henchman-ai/issues)
+- Use the bug report template
+- Include steps to reproduce, expected vs actual behavior, and environment details
+
+### 2. Suggesting Features
+- Check if the feature has already been suggested
+- Explain the use case and benefits
+- Consider if it aligns with the project's goals
+
+### 3. Contributing Code
+- Fork the repository
+- Create a feature branch (`git checkout -b feature/amazing-feature`)
+- Make your changes
+- Add or update tests
+- Ensure code passes linting and type checking
+- Submit a pull request
+
+## 🏗️ Development Setup
+
+### Prerequisites
+- Python 3.10 or higher
+- Git
+- (Optional) uv for faster dependency management
+
+### Installation
+```bash
+# Clone your fork
+git clone https://github.com/your-username/henchman-ai.git
+cd henchman-ai
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install with development dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks (optional but recommended)
+pre-commit install
+```
+
+### Running Tests
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=henchman --cov-report=term-missing
+
+# Run specific test files
+pytest tests/test_cli.py -v
+
+# Run integration tests
+pytest -m integration
+```
+
+### Code Quality
+```bash
+# Format code
+ruff format src/ tests/
+
+# Check linting
+ruff check src/ tests/
+
+# Type checking
+mypy src/
+
+# Security audit
+bandit -r src/
+```
+
+## 📁 Project Structure
+
+```
+henchman-ai/
+├── src/henchman/          # Source code
+│   ├── cli/              # CLI interface
+│   ├── core/             # Core functionality
+│   ├── providers/        # LLM provider implementations
+│   ├── tools/            # Tool implementations
+│   └── utils/            # Utility functions
+├── tests/                # Test suite
+├── docs/                 # Documentation
+├── scripts/              # Development scripts
+└── evals/                # Evaluation scripts
+```
+
+## 📝 Code Style
+
+### Python Style Guide
+- Follow [PEP 8](https://peps.python.org/pep-0008/)
+- Use type hints for all functions and methods
+- Document public APIs with docstrings (Google style)
+- Keep functions focused and small (< 50 lines when possible)
+
+### Docstring Format (Google Style)
+```python
+def process_file(filepath: str, mode: str = "read") -> str:
+    """Process a file with the given mode.
+    
+    Args:
+        filepath: Path to the file to process
+        mode: Processing mode ('read', 'write', 'append')
+    
+    Returns:
+        The processed content as a string
+    
+    Raises:
+        FileNotFoundError: If the file doesn't exist
+        ValueError: If mode is invalid
+    """
+    # Implementation
+```
+
+### Commit Messages
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+```
+feat: add new provider for Gemini
+fix: handle API rate limiting properly
+docs: update installation instructions
+test: add unit tests for file tools
+refactor: simplify configuration loading
+chore: update dependencies
+```
+
+## 🧪 Testing Guidelines
+
+### Unit Tests
+- Test one thing per test function
+- Use descriptive test names
+- Mock external dependencies
+- Aim for high coverage (> 80%)
+
+### Integration Tests
+- Test end-to-end functionality
+- Use real API calls (with test credentials)
+- Clean up after tests
+
+### Example Test
+```python
+import pytest
+from henchman.core.processor import process_prompt
+
+def test_process_prompt_with_valid_input():
+    """Test prompt processing with valid input."""
+    result = process_prompt("Hello, world!")
+    assert isinstance(result, str)
+    assert len(result) > 0
+
+def test_process_prompt_with_empty_input():
+    """Test prompt processing with empty input raises error."""
+    with pytest.raises(ValueError):
+        process_prompt("")
+```
+
+## 🔌 Adding New Providers
+
+1. Create a new file in `src/henchman/providers/`
+2. Implement the `BaseProvider` interface
+3. Add tests in `tests/providers/`
+4. Update documentation
+5. Add to provider registry
+
+## 🛠️ Adding New Tools
+
+1. Create a new file in `src/henchman/tools/`
+2. Implement the `BaseTool` interface
+3. Add safety checks and user confirmation
+4. Add tests
+5. Update documentation
+
+## 📚 Documentation
+
+### Updating Documentation
+- Documentation is in the `docs/` directory
+- Use Markdown with MkDocs
+- Build locally: `mkdocs serve`
+- Update API documentation when changing interfaces
+
+### Adding Examples
+- Add practical examples to relevant documentation
+- Include code snippets that can be copied
+- Show common use cases and edge cases
+
+## 🚀 Release Process
+
+### Versioning
+We follow [Semantic Versioning](https://semver.org/):
+- **MAJOR**: Breaking changes
+- **MINOR**: New features (backward compatible)
+- **PATCH**: Bug fixes (backward compatible)
+
+### Release Checklist
+1. Update version in `pyproject.toml`
+2. Update `CHANGELOG.md`
+3. Run full test suite
+4. Update documentation
+5. Create release tag
+6. Build and publish to PyPI
+
+## ❓ Getting Help
+
+- Check the [documentation](https://mgpowerlytics.github.io/henchman-ai/)
+- Search existing [issues](https://github.com/MGPowerlytics/henchman-ai/issues)
+- Join discussions in [GitHub Discussions](https://github.com/MGPowerlytics/henchman-ai/discussions)
+
+## 📄 License
+
+By contributing, you agree that your contributions will be licensed under the project's MIT License.
+
+---
+
+Thank you for contributing to make Henchman-AI better! 🎉