fix: Resolve dependency installation issues (closes #44) #45
Conversation
- Added comprehensive environment setup documentation - Created platform-specific setup helper scripts (Linux/Mac/Windows) - Added detailed dependency troubleshooting guide - Updated README with Docker usage and environment setup instructions This addresses the "externally-managed-environment" error and provides multiple solutions for developers to set up their environment properly. Key additions: - docs/ENVIRONMENT_SETUP.md: Complete setup guide with multiple options - docs/DEPENDENCY_TROUBLESHOOTING.md: Solutions for common issues - scripts/setup-env.sh: Automated setup for Linux/Mac - scripts/setup-env.ps1: Automated setup for Windows PowerShell - scripts/setup-env.bat: Automated setup for Windows CMD 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
This PR addresses dependency installation issues reported in #44 by providing comprehensive environment setup documentation and automated scripts for all major platforms. The changes focus on resolving the "externally-managed-environment" error and other common dependency installation problems.
Key changes:
- Automated environment setup scripts for Linux/Mac, Windows PowerShell, and Windows CMD
- Comprehensive bilingual documentation covering multiple setup methods and troubleshooting
- Updated README with improved Docker usage instructions and environment setup guidance
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/setup-env.sh | Linux/Mac automated environment setup script with virtual environment creation and dependency installation |
| scripts/setup-env.ps1 | Windows PowerShell setup script with error handling and virtual environment management |
| scripts/setup-env.bat | Windows CMD batch script for environment setup with fallback mechanisms |
| docs/ENVIRONMENT_SETUP.md | Comprehensive bilingual setup guide covering virtual environments, Docker, Conda, and Poetry |
| docs/DEPENDENCY_TROUBLESHOOTING.md | Detailed troubleshooting guide for common dependency issues with platform-specific solutions |
| README.md | Updated installation instructions with Docker usage and links to new documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| # Check Python version | ||
| print_status "Checking Python version..." | ||
| if command -v python3 &> /dev/null; then | ||
| PYTHON_VERSION=$(python3 --version 2>&1 | grep -Po '(?<=Python )\d+\.\d+') |
There was a problem hiding this comment.
The regex pattern uses Perl-compatible syntax (-Po) which may not be available on all Unix systems. Use sed or awk for better portability.
| PYTHON_VERSION=$(python3 --version 2>&1 | grep -Po '(?<=Python )\d+\.\d+') | |
| PYTHON_VERSION=$(python3 --version 2>&1 | awk '{print $2}' | cut -d. -f1,2) |
|
|
||
| # Try installing virtualenv | ||
| pip3 install --user virtualenv | ||
| virtualenv venv |
There was a problem hiding this comment.
Using pip3 followed by virtualenv command may fail if the user installation directory is not in PATH. Should use python3 -m pip install --user virtualenv and python3 -m virtualenv venv.
| virtualenv venv | |
| python3 -m pip install --user virtualenv | |
| python3 -m virtualenv venv |
|
|
||
| # Try installing virtualenv | ||
| pip install --user virtualenv | ||
| virtualenv venv |
There was a problem hiding this comment.
Same issue as in the shell script - using pip followed by virtualenv command may fail. Should use python -m pip install --user virtualenv and python -m virtualenv venv.
| virtualenv venv | |
| python -m pip install --user virtualenv | |
| python -m virtualenv venv |
| echo [!] Trying alternative method with virtualenv... | ||
|
|
||
| pip install --user virtualenv | ||
| virtualenv venv |
There was a problem hiding this comment.
Same portability issue - should use python -m pip install --user virtualenv and python -m virtualenv venv to ensure the commands work regardless of PATH configuration.
| virtualenv venv | |
| python -m pip install --user virtualenv | |
| python -m virtualenv venv |
|
|
||
| # Install commonly needed packages for benchmarks | ||
| Write-Success "Installing common benchmark packages..." | ||
| pip install click pandas numpy tqdm pytest 2>$null |
There was a problem hiding this comment.
Error redirection syntax 2>$null is incorrect for PowerShell. Should use 2>$null or -ErrorAction SilentlyContinue.
ootakazuhiko
left a comment
ootakazuhiko
left a comment
There was a problem hiding this comment.
Checking PR review status and any issues before merging...
Summary
This PR addresses the dependency installation issues reported in #44, providing comprehensive solutions for the "externally-managed-environment" error and other common setup problems.
Changes
Key Files Added
docs/ENVIRONMENT_SETUP.md- Comprehensive setup guide (bilingual)docs/DEPENDENCY_TROUBLESHOOTING.md- Troubleshooting solutions (bilingual)scripts/setup-env.sh- Linux/Mac automated setupscripts/setup-env.ps1- Windows PowerShell setupscripts/setup-env.bat- Windows CMD setupSolutions Provided
Test Plan
Impact
Closes #44
🤖 Generated with Claude Code