Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Installation Guide for Windows 11: Dependency Resolution Steps #1497

Open
umayado17 opened this issue Oct 24, 2024 · 4 comments
Labels
Documentation Improvements or additions to documentation

Comments

@umayado17
Copy link
Contributor

Is your feature request related to a problem? Please describe.

documentation, enhancement

Describe the solution you'd like

This is a guide for installing Open Interpreter on Windows 11 with Python 3.11, focusing on resolving dependency issues and providing a clear installation sequence.

Current Documentation Gap

The current documentation doesn't provide specific guidance for Windows users, who may encounter dependency conflicts during installation. This can lead to installation failures or runtime errors.

Suggested Documentation Addition

Windows 11 Installation Guide

Prerequisites

  • Windows 11
  • Python 3.11+
  • Administrative access for package installation

Step-by-Step Installation

  1. Create and activate a virtual environment:
python -m venv .venv
.venv\Scripts\activate
  1. Upgrade pip:
python -m pip install --upgrade pip
  1. Install dependencies in sequence:
pip install "starlette==0.37.2"
pip install "fastapi>=0.111.0"
pip install "pydantic>=2.6.4"
pip install "uvicorn>=0.30.1"
pip install "janus>=1.0.0"
  1. Install open-interpreter:
pip install "open-interpreter==0.4.1"
  1. For OS functionality, add:
pip install pyautogui
pip install opencv-python
pip install plyer
pip install pywinctl

Troubleshooting

Common issues and solutions:

  1. Dependency conflicts: Follow the above sequence
  2. Date format error with --os flag: Modify date format in loop.py from %-d to %d

Benefits

  • Reduces installation issues for Windows users
  • Provides clear troubleshooting steps
  • Improves user experience

Additional Suggestions

  1. Consider adding a Windows-specific section to the official documentation
  2. Create a dedicated requirements-windows.txt
  3. Add platform-specific checks in the installation script

Would you consider adding this to the official documentation?

Describe alternatives you've considered

No response

Additional context

No response

@killerapp
Copy link

I have been using pipx to install open-interpreter on Windows 11, and when I upgraded to .4 just now, I got this:

interpreter --os
Traceback (most recent call last):
File "", line 198, in _run_module_as_main
File "", line 88, in _run_code

...

ModuleNotFoundError: No module named 'pyautogui'

@umayado17
Copy link
Contributor Author

pip install pyautogui
pip install opencv-python
pip install plyer
pip install pywinctl

@killerapp
Copy link

I've got 3.12 as my main base on Win 11 - I use virtual envs or pipx to go down to 3.11 as needed... maybe that's not the right approach for Windows + AI tinkering.

using pipx ... not pip to enclose it in it's own env... I may back that out...

pipx inject open-interpreter pyautogui uvicorn fastapi

PS C:\Users\vaski> pipx inject open-interpreter pyautogui uvicorn fastapi
  injected package pyautogui into venv open-interpreter
done! ✨ 🌟 ✨
  injected package uvicorn into venv open-interpreter
done! ✨ 🌟 ✨
  injected package fastapi into venv open-interpreter
done! ✨ 🌟 ✨
PS C:\Users\vaski>
PS C:\Users\vaski>
PS C:\Users\vaski> interpreter --os
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "c:\users\vaski\.local\bin\interpreter.exe\__main__.py", line 4, in <module>
  File "C:\Users\vaski\pipx\venvs\open-interpreter\Lib\site-packages\interpreter\__init__.py", line 52, in <module>
    from .computer_use.loop import run_async_main
  File "C:\Users\vaski\pipx\venvs\open-interpreter\Lib\site-packages\interpreter\computer_use\loop.py", line 113, in <module>
    * The current date is {datetime.today().strftime('%A, %B %-d, %Y')}.
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ValueError: Invalid format string

@umayado17
Copy link
Contributor Author

If you avoid the conflict by following the procedure described in this issue and successfully install, the error message in the comment above will appear when you start the system. The solution to this error has been reported as Issue 1495. Please refer to that.

@MikeBirdTech MikeBirdTech added the Documentation Improvements or additions to documentation label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants