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

Virtualenv docs #1784

Open
wants to merge 5 commits into
base: master
from
Open

Virtualenv docs #1784

wants to merge 5 commits into from

Conversation

@pfaion
Copy link
Contributor

pfaion commented Jan 7, 2020

I added a unified note that virtualenvs are recommended. Reasons:

  • e.g. PIMonitor has conflicting dependencies with Pupil
  • when using a virtualenv you can just run pip everywhere instead of having to decide between pip and pip3
  • you don't need sudo pip when installing into a virtualenv

Since virtualenvs have trouble with apt installed Python packages on Ubuntu, I extended the notes on troubleshooting the OpenCV Python bindings. Also those were missing in the Ubuntu 18 docs. See this PR: #1775 for an example of how this can confuse users.

@papr does the trouble with system-installed opencv-python-bindings in virtualenvs also apply to macOS? Then we should add a note there as well. I found the --system-site-packages option a generally good thing to mention in that regard.

pfaion added 3 commits Jan 7, 2020
- Generally virtualenvs are recommended because different apps from Pupil-Labs require different dependencies to run.
- I removed the Python version number note, because the required Python version is already discussed in other parts of the docs.
- I also added a link to the official virtualenv docs in case users are new to that.
- Provide more context information on why this happens
- Add additional information about virtualenvs
- Provide solutions
@pfaion pfaion requested review from papr and romanroibu Jan 7, 2020
@pfaion

This comment has been minimized.

Copy link
Contributor Author

pfaion commented Jan 7, 2020

I created a draft until we clarify the macOS situation (@papr)

@pfaion pfaion self-assigned this Jan 10, 2020
@pfaion

This comment has been minimized.

Copy link
Contributor Author

pfaion commented Jan 10, 2020

I'll add additional notes to the macOS docs on 'No module named cv2' as well!

@pfaion pfaion marked this pull request as ready for review Jan 13, 2020
docs/dependencies-macos.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.