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
This commit is contained in:
33
README.md
33
README.md
@@ -149,11 +149,40 @@ Package skill at output/react/
|
||||
|
||||
### Method 2: CLI (Traditional)
|
||||
|
||||
#### One-Time Setup: Create Virtual Environment
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/yusufkaraaslan/Skill_Seekers.git
|
||||
cd Skill_Seekers
|
||||
|
||||
# Create virtual environment
|
||||
python3 -m venv venv
|
||||
|
||||
# Activate virtual environment
|
||||
source venv/bin/activate # macOS/Linux
|
||||
# OR on Windows: venv\Scripts\activate
|
||||
|
||||
# Install dependencies
|
||||
pip install requests beautifulsoup4 pytest
|
||||
|
||||
# Save dependencies
|
||||
pip freeze > requirements.txt
|
||||
|
||||
# Optional: Install anthropic for API-based enhancement (not needed for LOCAL enhancement)
|
||||
# pip install anthropic
|
||||
```
|
||||
|
||||
**Always activate the virtual environment before using Skill Seeker:**
|
||||
```bash
|
||||
source venv/bin/activate # Run this each time you start a new terminal session
|
||||
```
|
||||
|
||||
#### Easiest: Use a Preset
|
||||
|
||||
```bash
|
||||
# Install dependencies (macOS)
|
||||
pip3 install requests beautifulsoup4
|
||||
# Make sure venv is activated (you should see (venv) in your prompt)
|
||||
source venv/bin/activate
|
||||
|
||||
# Optional: Estimate pages first (fast, 1-2 minutes)
|
||||
python3 cli/estimate_pages.py configs/godot.json
|
||||
|
||||
Reference in New Issue
Block a user