Skip to content

Commit 5b36c37

Browse files
authored
Add note about piwheels, other fixes and notes
1 parent 7b7f734 commit 5b36c37

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1. If you have previous/other manually installed (= not installed via ``pip``) version of OpenCV installed (e.g. cv2 module in the root of Python's site-packages), remove it before installation to avoid conflicts.
1010
2. Select the correct package for your environment:
1111

12-
There are four different packages and you should **select only one of them**. Do not install multiple different packages in the same enviroment.
12+
There are four different packages and you should **select only one of them**. Do not install multiple different packages in the same enviroment. There is no plugin architecture: all the packages use the same namespace (`cv2`). If you installed multiple different packages in the same environment, uninstall them all with ``pip uninstall`` and reinstall only one package.
1313

1414
**a.** Packages for standard desktop environments (Windows, macOS, almost any GNU/Linux distribution)
1515

@@ -44,7 +44,7 @@ A: No, the packages are special wheel binary packages and they already contain s
4444

4545
**Q: Pip fails with ``Could not find a version that satisfies the requirement ...``?**
4646

47-
A: Most likely the issue is related to too old pip and can be fixed by running ``pip install --upgrade pip``. Note that PyPI does not currently support ARM architecture so you can't install these packages for example on Raspberry Pi.
47+
A: Most likely the issue is related to too old pip and can be fixed by running ``pip install --upgrade pip``. Note that the wheel (especially manylinux) format does not currently support properly ARM architecture so there are no packages for ARM based platforms in PyPI. However, ``opencv-python`` packages for Raspberry Pi can be found from https://www.piwheels.org/.
4848

4949
**Q: Import fails on Windows: ``ImportError: DLL load failed: The specified module could not be found.``?**
5050

@@ -56,6 +56,10 @@ If the above does not help, check if you are using Anaconda. Old Anaconda versio
5656

5757
A: Make sure you have removed old manual installations of OpenCV Python bindings (cv2.so or cv2.pyd in site-packages).
5858

59+
**Q: Why the package and import are different (opencv-python vs. cv2)?**
60+
61+
A: It's easier for users to understand ``opencv-python`` than ``cv2`` and it makes it easier to find the package with search engines. `cv2` (old interface in old OpenCV versions was named as `cv`) is the name that OpenCV developers chose when they created the binding generators. This is kept as the import name to be consistent with different kind of tutorials around the internet. Changing the import name or behaviour would be also confusing to experienced users who are accustomed to the ``import cv2``.
62+
5963
## Documentation for opencv-python
6064

6165
[![AppVeyor CI test status (Windows)](https://img.shields.io/appveyor/ci/skvark/opencv-python.svg?maxAge=3600&label=Windows)](https://ci.appveyor.com/project/skvark/opencv-python)
@@ -140,4 +144,4 @@ Currently, builds for following Python versions are provided:
140144
- 3.4
141145
- 3.5
142146
- 3.6
143-
- 3.7
147+
- 3.7

0 commit comments

Comments
 (0)