diff --git a/README.md b/README.md index 172210af7f..d43603cdff 100644 --- a/README.md +++ b/README.md @@ -127,3 +127,21 @@ gpt-engineer is [governed](https://github.com/gpt-engineer-org/gpt-engineer/blob https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/40d0a9a8-82d0-4432-9376-136df0d57c99 + + + +### 6. Update README.md + +Add a troubleshooting section to **`README.md`**: + +```markdown +## Troubleshooting + +### Installation Error: `canonicalize_version() got an unexpected keyword argument 'strip_trailing_zero'` + +If you encounter this error during installation, it's due to compatibility issues with setuptools and pyperclip. + +**Quick fix:** +```bash +pip install "setuptools<66.0" "pyperclip==1.8.2" +pip install gpt-engineer \ No newline at end of file diff --git a/scripts/install_fixed.ps1 b/scripts/install_fixed.ps1 new file mode 100644 index 0000000000..377800ba0a --- /dev/null +++ b/scripts/install_fixed.ps1 @@ -0,0 +1,20 @@ +Write-Host "Fixing pyperclip installation issue for gpt-engineer..." -ForegroundColor Green + +# Update pip to latest version +Write-Host "Upgrading pip..." +python -m pip install --upgrade pip + +# Install compatible setuptools version first +Write-Host "Installing compatible setuptools version..." +python -m pip install "setuptools>=45.0,<66.0" + +# Install pyperclip 1.8.2 specifically to avoid canonicalize_version error +Write-Host "Installing pyperclip 1.8.2..." +python -m pip install "pyperclip>=1.8.2,<1.9.0" + +# Install gpt-engineer in development mode +Write-Host "Installing gpt-engineer..." +python -m pip install -e . + +Write-Host "✅ Installation completed successfully!" -ForegroundColor Green +Write-Host "You can now run: gpte projects/example" \ No newline at end of file diff --git a/scripts/install_fixed.sh b/scripts/install_fixed.sh new file mode 100644 index 0000000000..b250e8ddd8 --- /dev/null +++ b/scripts/install_fixed.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +echo "Fixing pyperclip installation issue for gpt-engineer..." + +# Update pip to latest version +echo "Upgrading pip..." +pip install --upgrade pip + +# Install compatible setuptools version first +echo "Installing compatible setuptools version..." +pip install "setuptools>=45.0,<66.0" + +# Install pyperclip 1.8.2 specifically to avoid canonicalize_version error +echo "Installing pyperclip 1.8.2..." +pip install "pyperclip>=1.8.2,<1.9.0" + +# Install gpt-engineer in development mode +echo "Installing gpt-engineer..." +pip install -e . + +echo "✅ Installation completed successfully!" +echo "You can now run: gpte projects/example" \ No newline at end of file