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.md
+25-23
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,31 @@
2
2
3
3
## OpenCV on Wheels
4
4
5
-
**Unofficial** pre-built OpenCV packages for Python.
5
+
**Unofficial** pre-built CPU-only OpenCV packages for Python.
6
+
7
+
Check the manual build section if you wish to compile the bindings from source to enable additional modules such as CUDA.
6
8
7
9
### Installation and Usage
8
10
9
11
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.
10
-
2. Select the correct package for your environment:
12
+
2. Make sure that your `pip` version is up-to-date (19.3 is the minimum supported version): `pip install --upgrade pip`. Check version with `pip -V`. For example Linux distributions ship usually with very old `pip` versions which cause a lot of unexpected problems especially with the `manylinux` format.
13
+
3. Select the correct package for your environment:
11
14
12
-
There are four different packages and you should **select only one of them**. Do not install multiple different packages in the same environment. 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.
15
+
There are four different packages (see options 1, 2, 3 and 4 below) and you should **SELECT ONLY ONE OF THEM**. Do not install multiple different packages in the same environment. 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.
13
16
14
17
**a.** Packages for standard desktop environments (Windows, macOS, almost any GNU/Linux distribution)
15
18
16
-
-run ``pip install opencv-python`` if you need only main modules
17
-
-run ``pip install opencv-contrib-python`` if you need both main and contrib modules(check extra modules listing from [OpenCV documentation](https://docs.opencv.org/master/))
19
+
-Option 1 - Main modules package: ``pip install opencv-python``
20
+
-Option 2 - Full package (contains both main modules and contrib/extra modules): ``pip install opencv-contrib-python``(check contrib/extra modules listing from [OpenCV documentation](https://docs.opencv.org/master/))
18
21
19
-
**b.** Packages for server (headless) environments
22
+
**b.** Packages for server (headless) environments (such as Docker, cloud environments etc.), no GUI library dependencies
20
23
21
-
These packages do not contain any GUI functionality. They are smaller and suitable for more restricted environments.
24
+
These packages are smaller than the two other packages above because they do not contain any GUI functionality (not compiled with Qt / other GUI components). This means that the packages avoid a heavy dependency chain to X11 libraries and you will have for example smaller Docker images as a result. You should always use these packages if you do not use `cv2.imshow` et al. or you are using some other package (such as PyQt) than OpenCV to create your GUI.
22
25
23
-
-run ``pip install opencv-python-headless`` if you need only main modules
24
-
-run ``pip install opencv-contrib-python-headless`` if you need both main and contrib modules(check extra modules listing from [OpenCV documentation](https://docs.opencv.org/master/))
26
+
-Option 3 - Headless main modules package: ``pip install opencv-python-headless``
27
+
-Option 4 - Headless full package (contains both main modules and contrib/extra modules): ``pip install opencv-contrib-python-headless``(check contrib/extra modules listing from [OpenCV documentation](https://docs.opencv.org/master/))
25
28
26
-
3. Import the package:
29
+
4. Import the package:
27
30
28
31
``import cv2``
29
32
@@ -77,7 +80,7 @@ A: It's easier for users to understand ``opencv-python`` than ``cv2`` and it mak
77
80
## Documentation for opencv-python
78
81
79
82
[](https://ci.appveyor.com/project/skvark/opencv-python)
80
-
[](https://travis-ci.org/skvark/opencv-python)
83
+
[](https://travis-ci.com/github/skvark/opencv-python/)
81
84
82
85
The aim of this repository is to provide means to package each new [OpenCV release](https://github.com/opencv/opencv/releases) for the most used Python versions and platforms.
83
86
@@ -128,16 +131,18 @@ If some dependency is not enabled in the pre-built wheels, you can also run the
128
131
129
132
1. Clone this repository: `git clone --recursive https://github.com/skvark/opencv-python.git`
130
133
2.``cd opencv-python``
134
+
- you can use `git` to checkout some other version of OpenCV in the `opencv` and `opencv_contrib` submodules if needed
131
135
3. Add custom Cmake flags if needed, for example: `export CMAKE_ARGS="-DSOME_FLAG=ON -DSOME_OTHER_FLAG=OFF"` (in Windows you need to set environment variables differently depending on Command Line or PowerShell)
132
-
4. Select the version which you wish to build with `ENABLE_CONTRIB` and `ENABLE_HEADLESS`: i.e. `export ENABLE_CONTRIB=1` if you wish to build `opencv-contrib-python`
133
-
5. Run ``pip wheel . --verbose``. NOTE: make sure you have the latest ``pip``, the ``pip wheel`` command replaces the old ``python setup.py bdist_wheel`` command which does not support ``pyproject.toml``.
134
-
- Optional: on Linux use the `manylinux` images as a build hosts if maximum portability is needed and run `auditwheel` for the wheel after build
135
-
- Optional: on macOS use ``delocate`` (same as ``auditwheel`` but for macOS)
136
+
4. Select the package flavor which you wish to build with `ENABLE_CONTRIB` and `ENABLE_HEADLESS`: i.e. `export ENABLE_CONTRIB=1` if you wish to build `opencv-contrib-python`
137
+
5. Run ``pip wheel . --verbose``. NOTE: make sure you have the latest ``pip`` version, the ``pip wheel`` command replaces the old ``python setup.py bdist_wheel`` command which does not support ``pyproject.toml``.
138
+
- this might take anything from 5 minutes to over 2 hours depending on your hardware
136
139
6. You'll have the wheel file in the `dist` folder and you can do with that whatever you wish
140
+
- Optional: on Linux use some of the `manylinux` images as a build hosts if maximum portability is needed and run `auditwheel` for the wheel after build
141
+
- Optional: on macOS use ``delocate`` (same as ``auditwheel`` but for macOS) for better portability
137
142
138
143
#### Source distributions
139
144
140
-
Since OpenCV version 4.3.0, also source distributions are provided in PyPI. This means that if your system is not compatible with any of the wheels in PyPI, ``pip`` will attempt to build OpenCV from sources.
145
+
Since OpenCV version 4.3.0, also source distributions are provided in PyPI. This means that if your system is not compatible with any of the wheels in PyPI, ``pip`` will attempt to build OpenCV from sources. If you need a OpenCV version which is not available in PyPI as a source distribution, please follow the manual build guidance above instead of this one.
141
146
142
147
You can also force ``pip`` to build the wheels from the source distribution. Some examples:
143
148
@@ -146,7 +151,7 @@ You can also force ``pip`` to build the wheels from the source distribution. Som
146
151
147
152
If you need contrib modules or headless version, just change the package name (step 4 in the previous section is not needed). However, any additional CMake flags can be provided via environment variables as described in step 3 of the manual build section. If none are provided, OpenCV's CMake scripts will attempt to find and enable any suitable dependencies. Headless distributions have hard coded CMake flags which disable all possible GUI dependencies.
148
153
149
-
Please note that build tools and ``numpy`` are required for the build to succeed. On slow systems such as Raspberry Pi the full build may take several hours. On a 8-core Ryzen 7 3700X the build takes about 6 minutes.
154
+
On slow systems such as Raspberry Pi the full build may take several hours. On a 8-core Ryzen 7 3700X the build takes about 6 minutes.
150
155
151
156
### Licensing
152
157
@@ -184,17 +189,14 @@ These artifacts can't be and will not be uploaded to PyPI.
184
189
185
190
### Manylinux wheels
186
191
187
-
Linux wheels are built using [manylinux](https://github.com/pypa/python-manylinux-demo). These wheels should work out of the box for most of the distros (which use GNU C standard library) out there since they are built against an old version of glibc.
192
+
Linux wheels are built using [manylinux2014](https://github.com/pypa/manylinux). These wheels should work out of the box for most of the distros (which use GNU C standard library) out there since they are built against an old version of glibc.
188
193
189
-
The default ``manylinux`` images have been extended with some OpenCV dependencies. See [Docker folder](https://github.com/skvark/opencv-python/tree/master/docker) for more info.
194
+
The default ``manylinux2014`` images have been extended with some OpenCV dependencies. See [Docker folder](https://github.com/skvark/opencv-python/tree/master/docker) for more info.
190
195
191
196
### Supported Python versions
192
197
193
-
Python 3.x releases are provided for officially supported versions (not in EOL).
194
-
195
-
Currently, builds for following Python versions are provided:
198
+
Python 3.x compatible pre-built wheels are provided for the officially supported Python versions (not in EOL):
196
199
197
-
- 3.5 (EOL in 2020-09-13, builds for 3.5 will not be provided after this)
0 commit comments