You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+31-18Lines changed: 31 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,48 +31,51 @@ Installation and Usage
31
31
32
32
1. If you have previous/other version of OpenCV installed (e.g. cv2 module in the root of Python's site-packages), remove it before installation to avoid conflicts.
33
33
- To further avoid conflicts and to make development easier, Python's `virtual environments <https://docs.python.org/3/library/venv.html>`__ are highly recommended for development purposes.
34
-
2. Install this package:
34
+
35
+
2. If you have an existing ``opencv-contrib-python`` installation, run ``pip uninstall opencv-contrib-python``
5. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
47
+
6. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
45
48
46
49
Frequently Asked Questions
47
50
--------------------------
48
51
49
-
Q: Do I need to install also OpenCV separately?
52
+
**Q: Do I need to install also OpenCV separately?**
50
53
51
54
A: No, the packages are special wheel binary packages and they already contain statically built OpenCV binaries.
52
55
53
-
Q: Pip does not find package opencv-python?
56
+
**Q: Pip does not find package ``opencv-python``?**
54
57
55
58
A: The wheel package format and manylinux builds are pretty new things. Most likely the issue is related to too old pip and can be fixed by running ``pip install --upgrade pip``.
56
59
57
-
Q: I need contrib modules?
60
+
**Q: I need contrib modules?**
58
61
59
62
A: Please install `opencv-contrib-python <https://pypi.python.org/pypi/opencv-contrib-python>`__ instead. However, note that commercial usage might be restricted in some countries since the contrib modules contain some non-free/patented algorithms.
60
63
61
-
Q: Import fails on Windows to some DLL load error?
64
+
**Q: Import fails on Windows to some DLL load error?**
62
65
63
66
A: If the import fails on Windows, make sure you have `Visual C++ redistributable 2015 <https://www.microsoft.com/en-us/download/details.aspx?id=48145>`__ installed. If you are using older Windows version than Windows 10 and latest system updates are not installed, `Universal C Runtime <https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows>`__ might be also required.
64
67
65
-
Q: I have some other import errors?
68
+
**Q: I have some other import errors?**
66
69
67
70
A: Make sure you have removed old manual installations of OpenCV Python bindings (cv2.so or cv2.pyd in site-packages).
68
71
69
-
Q: Why I can't open video files on GNU/Linux distribution X or on macOS?
72
+
**Q: Why I can't open video files on GNU/Linux distribution X or on macOS?**
70
73
71
74
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries are not compiled against it.
72
75
The purpose of these packages is to provide as easy as possible installation experience for OpenCV Python bindings and they should work directly out-of-the-box.
73
76
Adding FFmpeg as an additional dependency without a "universal" FFmpeg build (e.g. LGPL licensed static build like in the Windows wheels) the goal is considerably harder to achieve. This might change in the future.
74
77
75
-
Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?
78
+
**Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?**
76
79
77
80
A: Like above, OpenCV was not compiled against GTK or Carbon. Support for these might be added in the future.
78
81
@@ -91,36 +94,46 @@ Build process
91
94
-------------
92
95
93
96
The project is structured like a normal Python package with a standard
94
-
``setup.py`` file. The build process is as follows (see for example
97
+
``setup.py`` file. The build process for a single entry in the build matrices is as follows (see for example
95
98
``appveyor.yml`` file):
96
99
97
100
1. Checkout repository and submodules
98
101
99
102
- OpenCV is included as submodule and the version is updated
100
103
manually by maintainers when a new OpenCV release has been made
104
+
- Contrib modules are also included as a submodule
101
105
102
106
2. Find OpenCV version from the sources
103
-
3. Upgrade pip and install numpy for each Python version
107
+
3. Install dependencies (numpy)
104
108
4. Build OpenCV
105
109
106
110
- tests are disabled, otherwise build time increases too much
111
+
- there are 2 build matrix entries for each build combination: with and without contrib modules
112
+
- Linux builds run in manylinux Docker containers (CentOS 5)
107
113
108
114
5. Copy each ``.pyd/.so`` file to cv2 folder of this project and
109
115
generate wheel
110
-
6. Install the generated wheels for each Python version
111
-
7. Test that the Python versions can import them
112
-
8. Use twine to upload all wheels to PyPI
116
+
117
+
- Linux and macOS wheels are checked with auditwheel and delocate
118
+
119
+
6. Install the generated wheel
120
+
7. Test that Python can import the library and run some sanity checks
121
+
8. Use twine to upload the generated wheel to PyPI (only in release builds)
113
122
114
123
Currently the ``find_version.py`` file parses OpenCV version information
115
124
from the OpenCV sources. OpenCV depends on numpy, so ``setup.py`` checks
116
-
the numpy version also with the help of pip.
125
+
the minimum required numpy version also with the help of pip.
117
126
118
-
The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
127
+
The ``cv2.pyd`` file is normally copied to site-packages.
119
128
To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
120
129
handles the import logic correctly by importing the actual ``.pyd`` module
121
130
and replacing the imported cv2 package in ``sys.modudes`` with the
122
131
cv2 module to retain backward compatibility.
123
132
133
+
Since both ``opencv-python`` and ``opencv-contrib-python`` use the same namespace explained above,
134
+
it is highly recommended to uninstall the other package before switching from example from
135
+
``opencv-python`` to ``opencv-contrib-python`` package.
Copy file name to clipboardExpand all lines: README_CONTRIB.rst
+31-20Lines changed: 31 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ OpenCV on Wheels
11
11
12
12
**Unofficial** OpenCV packages for Python with contrib modules.
13
13
14
-
**Usage of opencv-contrib-python might be restricted in some countries since the contrib package contains some patented algorithms/non-free modules.**
14
+
**Note: the usage of opencv-contrib-python might be restricted in some countries since the contrib package contains some patented algorithms/non-free modules.**
15
15
16
16
If you are looking for a version without the contrib modules, please install `opencv-python <https://pypi.python.org/pypi/opencv-python>`__ instead.
17
17
@@ -32,44 +32,45 @@ Installation and Usage
32
32
33
33
1. If you have previous/other version of OpenCV installed (e.g. cv2 module in the root of Python's site-packages), remove it before installation to avoid conflicts.
34
34
- To further avoid conflicts and to make development easier, Python's `virtual environments <https://docs.python.org/3/library/venv.html>`__ are highly recommended for development purposes.
35
-
2. Install this package:
35
+
2. If you have an existing ``opencv-python`` installation, run ``pip uninstall opencv-python``
5. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
46
+
6. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
46
47
47
48
Frequently Asked Questions
48
49
--------------------------
49
50
50
-
Q: Do I need to install also OpenCV separately?
51
+
**Q: Do I need to install also OpenCV separately?**
51
52
52
53
A: No, the packages are special wheel binary packages and they already contain statically built OpenCV binaries.
53
54
54
-
Q: Pip does not find package opencv-contrib-python?
55
+
**Q: Pip does not find package opencv-contrib-python?**
55
56
56
57
A: The wheel package format and manylinux builds are pretty new things. Most likely the issue is related to too old pip and can be fixed by running ``pip install --upgrade pip``.
57
58
58
-
Q: Import fails on Windows to some DLL load error?
59
+
**Q: Import fails on Windows to some DLL load error?**
59
60
60
61
A: If the import fails on Windows, make sure you have `Visual C++ redistributable 2015 <https://www.microsoft.com/en-us/download/details.aspx?id=48145>`__ installed. If you are using older Windows version than Windows 10 and latest system updates are not installed, `Universal C Runtime <https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows>`__ might be also required.
61
62
62
-
Q: I have some other import errors?
63
+
**Q: I have some other import errors?**
63
64
64
65
A: Make sure you have removed old manual installations of OpenCV Python bindings (cv2.so or cv2.pyd in site-packages).
65
66
66
-
Q: Why I can't open video files on GNU/Linux distribution X or on macOS?
67
+
**Q: Why I can't open video files on GNU/Linux distribution X or on macOS?**
67
68
68
-
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries are not compiled against it.
69
+
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries provided withing these packages are not compiled against it.
69
70
The purpose of these packages is to provide as easy as possible installation experience for OpenCV Python bindings and they should work directly out-of-the-box.
70
71
Adding FFmpeg as an additional dependency without a "universal" FFmpeg build (e.g. LGPL licensed static build like in the Windows wheels) the goal is considerably harder to achieve. This might change in the future.
71
72
72
-
Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?
73
+
**Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?**
73
74
74
75
A: Like above, OpenCV was not compiled against GTK or Carbon. Support for these might be added in the future.
75
76
@@ -88,36 +89,46 @@ Build process
88
89
-------------
89
90
90
91
The project is structured like a normal Python package with a standard
91
-
``setup.py`` file. The build process is as follows (see for example
92
+
``setup.py`` file. The build process for a single entry in the build matrices is as follows (see for example
92
93
``appveyor.yml`` file):
93
94
94
95
1. Checkout repository and submodules
95
96
96
97
- OpenCV is included as submodule and the version is updated
97
98
manually by maintainers when a new OpenCV release has been made
99
+
- Contrib modules are also included as a submodule
98
100
99
101
2. Find OpenCV version from the sources
100
-
3. Upgrade pip and install numpy for each Python version
102
+
3. Install dependencies (numpy)
101
103
4. Build OpenCV
102
104
103
105
- tests are disabled, otherwise build time increases too much
106
+
- there are 2 build matrix entries for each build combination: with and without contrib modules
107
+
- Linux builds run in manylinux Docker containers (CentOS 5)
104
108
105
109
5. Copy each ``.pyd/.so`` file to cv2 folder of this project and
106
110
generate wheel
107
-
6. Install the generated wheels for each Python version
108
-
7. Test that the Python versions can import them
109
-
8. Use twine to upload all wheels to PyPI
111
+
112
+
- Linux and macOS wheels are checked with auditwheel and delocate
113
+
114
+
6. Install the generated wheel
115
+
7. Test that python can import the library and run some sanity checks
116
+
8. Use twine to upload the generated wheel to PyPI (only in release builds)
110
117
111
118
Currently the ``find_version.py`` file parses OpenCV version information
112
119
from the OpenCV sources. OpenCV depends on numpy, so ``setup.py`` checks
113
-
the numpy version also with the help of pip.
120
+
the minimum required numpy version also with the help of pip.
114
121
115
-
The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
122
+
The ``cv2.pyd`` file is normally copied to site-packages.
116
123
To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
117
124
handles the import logic correctly by importing the actual ``.pyd`` module
118
125
and replacing the imported cv2 package in ``sys.modudes`` with the
119
126
cv2 module to retain backward compatibility.
120
127
128
+
Since both ``opencv-python`` and ``opencv-python-contrib`` use the same namespace explained above,
129
+
it is highly recommended to uninstall the other package before switching from example from
130
+
``opencv-python`` to ``opencv-python-contrib`` package.
0 commit comments