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.
- 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.
2. Install this package:
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.
6. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
Frequently Asked Questions
--------------------------
Q: Do I need to install also OpenCV separately?
**Q: Do I need to install also OpenCV separately?**
A: No, the packages are special wheel binary packages and they already contain statically built OpenCV binaries.
Q: Pip does not find package opencv-python?
**Q: Pip does not find package ``opencv-python``?**
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``.
Q: I need contrib modules?
**Q: I need contrib modules?**
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.
Q: Import fails on Windows to some DLL load error?
**Q: Import fails on Windows to some DLL load error?**
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.
Q: I have some other import errors?
**Q: I have some other import errors?**
A: Make sure you have removed old manual installations of OpenCV Python bindings (cv2.so or cv2.pyd in site-packages).
Q: Why I can't open video files on GNU/Linux distribution X or on macOS?
**Q: Why I can't open video files on GNU/Linux distribution X or on macOS?**
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries are not compiled against it.
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.
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.
Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?
**Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?**
A: Like above, OpenCV was not compiled against GTK or Carbon. Support for these might be added in the future.
...
...
@@ -91,36 +94,46 @@ Build process
-------------
The project is structured like a normal Python package with a standard
``setup.py`` file. The build process is as follows (see for example
``setup.py`` file. The build process for a single entry in the build matrices is as follows (see for example
``appveyor.yml`` file):
1. Checkout repository and submodules
- OpenCV is included as submodule and the version is updated
manually by maintainers when a new OpenCV release has been made
- Contrib modules are also included as a submodule
2. Find OpenCV version from the sources
3. Upgrade pip and install numpy for each Python version
3. Install dependencies (numpy)
4. Build OpenCV
- tests are disabled, otherwise build time increases too much
- there are 2 build matrix entries for each build combination: with and without contrib modules
- Linux builds run in manylinux Docker containers (CentOS 5)
5. Copy each ``.pyd/.so`` file to cv2 folder of this project and
generate wheel
6. Install the generated wheels for each Python version
7. Test that the Python versions can import them
8. Use twine to upload all wheels to PyPI
- Linux and macOS wheels are checked with auditwheel and delocate
6. Install the generated wheel
7. Test that Python can import the library and run some sanity checks
8. Use twine to upload the generated wheel to PyPI (only in release builds)
Currently the ``find_version.py`` file parses OpenCV version information
from the OpenCV sources. OpenCV depends on numpy, so ``setup.py`` checks
the numpy version also with the help of pip.
the minimum required numpy version also with the help of pip.
The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
The ``cv2.pyd`` file is normally copied to site-packages.
To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
handles the import logic correctly by importing the actual ``.pyd`` module
and replacing the imported cv2 package in ``sys.modudes`` with the
cv2 module to retain backward compatibility.
Since both ``opencv-python`` and ``opencv-contrib-python`` use the same namespace explained above,
it is highly recommended to uninstall the other package before switching from example from
``opencv-python`` to ``opencv-contrib-python`` package.
**Unofficial** OpenCV packages for Python with contrib modules.
**Usage of opencv-contrib-python might be restricted in some countries since the contrib package contains some patented algorithms/non-free modules.**
**Note: the usage of opencv-contrib-python might be restricted in some countries since the contrib package contains some patented algorithms/non-free modules.**
If you are looking for a version without the contrib modules, please install `opencv-python <https://pypi.python.org/pypi/opencv-python>`__ instead.
...
...
@@ -32,44 +32,45 @@ Installation and Usage
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.
- 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.
2. Install this package:
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.
6. Before opening a new issue, read the FAQ below and have a look at the other issues which are already open.
Frequently Asked Questions
--------------------------
Q: Do I need to install also OpenCV separately?
**Q: Do I need to install also OpenCV separately?**
A: No, the packages are special wheel binary packages and they already contain statically built OpenCV binaries.
Q: Pip does not find package opencv-contrib-python?
**Q: Pip does not find package opencv-contrib-python?**
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``.
Q: Import fails on Windows to some DLL load error?
**Q: Import fails on Windows to some DLL load error?**
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.
Q: I have some other import errors?
**Q: I have some other import errors?**
A: Make sure you have removed old manual installations of OpenCV Python bindings (cv2.so or cv2.pyd in site-packages).
Q: Why I can't open video files on GNU/Linux distribution X or on macOS?
**Q: Why I can't open video files on GNU/Linux distribution X or on macOS?**
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries are not compiled against it.
A: OpenCV video I/O depends heavily on FFmpeg. Manylinux and macOS OpenCV binaries provided withing these packages are not compiled against it.
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.
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.
Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?
**Q: Why I can't open GUI windows (``cv2.imshow()``) on GNU/Linux distribution X or on macOS?**
A: Like above, OpenCV was not compiled against GTK or Carbon. Support for these might be added in the future.
...
...
@@ -88,36 +89,46 @@ Build process
-------------
The project is structured like a normal Python package with a standard
``setup.py`` file. The build process is as follows (see for example
``setup.py`` file. The build process for a single entry in the build matrices is as follows (see for example
``appveyor.yml`` file):
1. Checkout repository and submodules
- OpenCV is included as submodule and the version is updated
manually by maintainers when a new OpenCV release has been made
- Contrib modules are also included as a submodule
2. Find OpenCV version from the sources
3. Upgrade pip and install numpy for each Python version
3. Install dependencies (numpy)
4. Build OpenCV
- tests are disabled, otherwise build time increases too much
- there are 2 build matrix entries for each build combination: with and without contrib modules
- Linux builds run in manylinux Docker containers (CentOS 5)
5. Copy each ``.pyd/.so`` file to cv2 folder of this project and
generate wheel
6. Install the generated wheels for each Python version
7. Test that the Python versions can import them
8. Use twine to upload all wheels to PyPI
- Linux and macOS wheels are checked with auditwheel and delocate
6. Install the generated wheel
7. Test that python can import the library and run some sanity checks
8. Use twine to upload the generated wheel to PyPI (only in release builds)
Currently the ``find_version.py`` file parses OpenCV version information
from the OpenCV sources. OpenCV depends on numpy, so ``setup.py`` checks
the numpy version also with the help of pip.
the minimum required numpy version also with the help of pip.
The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
The ``cv2.pyd`` file is normally copied to site-packages.
To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
handles the import logic correctly by importing the actual ``.pyd`` module
and replacing the imported cv2 package in ``sys.modudes`` with the
cv2 module to retain backward compatibility.
Since both ``opencv-python`` and ``opencv-python-contrib`` use the same namespace explained above,
it is highly recommended to uninstall the other package before switching from example from
``opencv-python`` to ``opencv-python-contrib`` package.
