Preston Brown
|
de5344caf9
|
Add virtual environment setup and minimal dependencies (#149)
## Changes
- Add virtual environment setup instructions to all docs
- Create requirements.txt with minimal dependencies (13 packages)
- Make anthropic optional (only needed for API enhancement)
- Clarify path notation (~ = $HOME, /Users/yourname examples)
- Add venv activation reminders throughout documentation
## Files Changed
- README.md: Added venv setup section to CLI method
- BULLETPROOF_QUICKSTART.md: Replaced Step 4 with venv setup
- CLAUDE.md: Updated Prerequisites with venv instructions
- requirements.txt: Created with minimal deps (requests, beautifulsoup4, pytest)
## Why
- Prevents package conflicts and permission issues
- Standard Python development practice
- Enables proper pytest usage without pipx complications
- Makes setup clearer for beginners
|
2025-10-22 21:54:05 +03:00 |
|
yusyus
|
9028974da9
|
Fix Issue #8: Add bulletproof setup and prerequisites
Addresses community feedback about missing setup steps.
New Documentation:
+ BULLETPROOF_QUICKSTART.md - Complete beginner guide
- Step-by-step Python/Git installation
- Every step with expected output
- Troubleshooting for each step
- Test example (5-page scrape)
- 15-30 minute complete setup
+ TROUBLESHOOTING.md - Comprehensive troubleshooting
- Installation issues (Python, pip, permissions)
- Runtime issues (file not found, configs)
- MCP setup issues (placeholder paths!)
- Scraping issues (slow, empty content)
- Platform-specific (macOS/Linux/Windows)
- Verification commands
Setup Script Improvements:
✅ Fixed setup_mcp.sh path expansion
- Now shows ACTUAL paths (not $REPO_PATH placeholder)
- Verifies paths exist after writing config
- Shows config contents for verification
- Tests MCP server path validity
- Clear warning about placeholders
README Updates:
✅ Added Prerequisites section
- Python 3.10+ requirement clear
- Git requirement clear
- Links to bulletproof guide
✅ Added git clone step to Quick Start
✅ Reorganized Documentation section
- Getting Started (new, beginner, troubleshooting)
- Guides (advanced topics)
- Technical (architecture)
Fixes:
- Issue #8 - Prereqs to Getting Started
- Issue #114 on project board (H1.1)
- Placeholder path problem in MCP setup
- Missing beginner-friendly docs
Impact: New users can now get started without confusion!
|
2025-10-21 00:04:26 +03:00 |
|