๐จโ๐ป Developer Installation
Suitable for developers, convenient for debugging and secondary development
Environment Setup
Check Python version (requires 3.8+):
python3 --versionRecommended to use uv (faster package manager):
pip install uvInstall Dependencies
Method 1: Using uv (recommended)
uv venv
source .venv/bin/activate
uv pip install -r requirements.txtMethod 2: Using pip
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txtRunning Modes
Direct Run (Debug Mode)
# Activate virtual environment
source .venv/bin/activate
# Run directly
python main.pyBackground Mode
# Install as background service
./install.sh
# View logs
tail -f logs/wintermelon_scribe.logDevelopment Workflow
Running from Source
For debugging and development:
# Make sure you're in the venv
source .venv/bin/activate
# Run with debug output
python main.py --debugFile Structure
wintermelon_scribe/
โโโ main.py # Main entry point
โโโ requirements.txt # Dependencies
โโโ install.sh # Installation script
โโโ uninstall.sh # Uninstallation script
โโโ status.sh # Status check script
โโโ .env.example # Environment template
โโโ logs/ # Log files
โโโ src/ # Source codeDebugging
View runtime logs:
# Real-time logs
tail -f logs/wintermelon_scribe.log
# Error logs
tail -f logs/wintermelon_scribe.errContributing
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
Configuration for Development
Create a .env file from .env.example:
cp .env.example .envEdit .env for development:
# Enable debug mode
DEBUG=true
# Use test API keys
SILICONFLOW_API_KEY=your-test-key
# Enable notifications
NOTIFICATION_ENABLED=true
NOTIFICATION_SOUND_ENABLED=trueCommon Development Issues
Q: Python version compatibility
- Requires Python 3.8 or higher
- Use pyenv if you need multiple Python versions
Q: Permission denied on macOS
- Grant Accessibility and Screen Recording permissions
- Use
chmod +x *.shfor scripts if needed
Q: Import errors
- Make sure you're in the virtual environment
- Run
pip install -r requirements.txtagain