Skip to content

Commit 42baf3c

Browse files
committed
Documentation update after migration to OpenCV organization on Github.
1 parent aa26990 commit 42baf3c

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

CONTRIBUTING.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ Thank you for considering contributing to opencv-python.
66

77
If you've noticed a bug or have a question that doesn't belong on
88
[Stack Overflow](http://stackoverflow.com/questions/tagged/opencv-python),
9-
[search the issue tracker](https://github.com/skvark/opencv-python/issues?q=something)
9+
[search the project issue tracker](https://github.com/opencv/opencv-python/issues?q=something) or
10+
[search OpenCV issue tracker](https://github.com/opencv/opencv/issues?q=is%3Aissue+is%3Aopen+label%3A%22category%3A+python+bindings%22)
1011
to see if someone else in the community has already created a ticket.
11-
If not, go ahead and [make one](https://github.com/skvark/opencv-python/issues/new)!
12+
If not, go ahead and:
13+
- [make new one for opencv-python](https://github.com/opencv/opencv-python/issues/new) if you cannot load package or some functionality is not available!
14+
- [make new one for OpenCV](https://github.com/opencv/opencv-python/issues/new) if something went wrong with some function, class or method in code!
1215

1316
### 2. Fork & create a branch
1417

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## OpenCV on Wheels
44

5-
**Unofficial** pre-built CPU-only OpenCV packages for Python.
5+
Pre-built CPU-only OpenCV packages for Python.
66

7-
Check the manual build section if you wish to compile the bindings from source to enable additional modules such as CUDA.
7+
Check the manual build section if you wish to compile the bindings from source to enable additional modules such as CUDA.
88

99
### Installation and Usage
1010

@@ -30,7 +30,7 @@ Check the manual build section if you wish to compile the bindings from source t
3030

3131
``import cv2``
3232

33-
All packages contain haarcascade files. ``cv2.data.haarcascades`` can be used as a shortcut to the data folder. For example:
33+
All packages contain Haar cascade files. ``cv2.data.haarcascades`` can be used as a shortcut to the data folder. For example:
3434

3535
``cv2.CascadeClassifier(cv2.data.haarcascades + "haarcascade_frontalface_default.xml")``
3636

@@ -57,14 +57,18 @@ Windows N and KN editions do not include Media Feature Pack which is required by
5757

5858
If you have Windows Server 2012+, media DLLs are probably missing too; please install the Feature called "Media Foundation" in the Server Manager. Beware, some posts advise to install "Windows Server Essentials Media Pack", but this one requires the "Windows Server Essentials Experience" role, and this role will deeply affect your Windows Server configuration (by enforcing active directory integration etc.); so just installing the "Media Foundation" should be a safer choice.
5959

60-
If the above does not help, check if you are using Anaconda. Old Anaconda versions have a bug which causes the error, see [this issue](https://github.com/skvark/opencv-python/issues/36) for a manual fix.
60+
If the above does not help, check if you are using Anaconda. Old Anaconda versions have a bug which causes the error, see [this issue](https://github.com/opencv/opencv-python/issues/36) for a manual fix.
6161

6262
If you still encounter the error after you have checked all the previous solutions, download [Dependencies](https://github.com/lucasg/Dependencies) and open the ``cv2.pyd`` (located usually at ``C:\Users\username\AppData\Local\Programs\Python\PythonXX\Lib\site-packages\cv2``) file with it to debug missing DLL issues.
6363

6464
**Q: I have some other import errors?**
6565

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

68+
**Q: Function foo() or method bar() returns wrong result, throws exception or crashes interpriter. What should I do?**
69+
70+
A: The repository contains only OpenCV-Python package build scripts, but not OpenCV itself. Python bindings for OpenCV are developed in official OpenCV repository and it's the best place to report issues. Also please check {OpenCV wiki](https://github.com/opencv/opencv/wiki) and [the fficial OpenCV forum](https://forum.opencv.org/) before file new bugs.
71+
6872
**Q: Why the packages do not include non-free algorithms?**
6973

7074
A: Non-free algorithms such as SURF are not included in these packages because they are patented / non-free and therefore cannot be distributed as built binaries. Note that SIFT is included in the builds due to patent expiration since OpenCV versions 4.3.0 and 3.4.10. See this issue for more info: https://github.com/skvark/opencv-python/issues/126
@@ -100,7 +104,7 @@ The build process for a single entry in the build matrices is as follows (see fo
100104
- tests are disabled, otherwise build time increases too much
101105
- there are 4 build matrix entries for each build combination: with and without contrib modules, with and without GUI (headless)
102106
- Linux builds run in manylinux Docker containers (CentOS 5)
103-
- source distributions are separate entries in the build matrix
107+
- source distributions are separate entries in the build matrix
104108

105109
4. Rearrange OpenCV's build result, add our custom files and generate wheel
106110

@@ -117,15 +121,15 @@ The build can be customized with environment variables. In addition to any varia
117121
- ``CI_BUILD``. Set to ``1`` to emulate the CI environment build behaviour. Used only in CI builds to force certain build flags on in ``setup.py``. Do not use this unless you know what you are doing.
118122
- ``ENABLE_CONTRIB`` and ``ENABLE_HEADLESS``. Set to ``1`` to build the contrib and/or headless version
119123
- ``ENABLE_JAVA``, Set to ``1`` to enable the Java client build. This is disabled by default.
120-
- ``CMAKE_ARGS``. Additional arguments for OpenCV's CMake invocation. You can use this to make a custom build.
124+
- ``CMAKE_ARGS``. Additional arguments for OpenCV's CMake invocation. You can use this to make a custom build.
121125

122126
See the next section for more info about manual builds outside the CI environment.
123127

124128
### Manual builds
125129

126130
If some dependency is not enabled in the pre-built wheels, you can also run the build locally to create a custom wheel.
127131

128-
1. Clone this repository: `git clone --recursive https://github.com/skvark/opencv-python.git`
132+
1. Clone this repository: `git clone --recursive https://github.com/opencv/opencv-python.git`
129133
2. ``cd opencv-python``
130134
- you can use `git` to checkout some other version of OpenCV in the `opencv` and `opencv_contrib` submodules if needed
131135
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)
@@ -152,18 +156,18 @@ export VERBOSE=1
152156
python3 setup.py bdist_wheel --build-type=Debug
153157
```
154158

155-
See this issue for more discussion: https://github.com/skvark/opencv-python/issues/424
159+
See this issue for more discussion: https://github.com/opencv/opencv-python/issues/424
156160

157161
#### Source distributions
158162

159163
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.
160164

161-
You can also force ``pip`` to build the wheels from the source distribution. Some examples:
165+
You can also force ``pip`` to build the wheels from the source distribution. Some examples:
162166

163167
- ``pip install --no-binary opencv-python opencv-python``
164168
- ``pip install --no-binary :all: opencv-python``
165169

166-
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.
170+
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.
167171

168172
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.
169173

@@ -173,13 +177,13 @@ Opencv-python package (scripts in this repository) is available under MIT licens
173177

174178
OpenCV itself is available under [Apache 2](https://github.com/opencv/opencv/blob/master/LICENSE) license.
175179

176-
Third party package licenses are at [LICENSE-3RD-PARTY.txt](https://github.com/skvark/opencv-python/blob/master/LICENSE-3RD-PARTY.txt).
180+
Third party package licenses are at [LICENSE-3RD-PARTY.txt](https://github.com/opencv/opencv-python/blob/master/LICENSE-3RD-PARTY.txt).
177181

178182
All wheels ship with [FFmpeg](http://ffmpeg.org) licensed under the [LGPLv2.1](http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).
179183

180184
Non-headless Linux and MacOS wheels ship with [Qt 5](http://doc.qt.io/qt-5/lgpl.html) licensed under the [LGPLv3](http://www.gnu.org/licenses/lgpl-3.0.html).
181185

182-
The packages include also other binaries. Full list of licenses can be found from [LICENSE-3RD-PARTY.txt](https://github.com/skvark/opencv-python/blob/master/LICENSE-3RD-PARTY.txt).
186+
The packages include also other binaries. Full list of licenses can be found from [LICENSE-3RD-PARTY.txt](https://github.com/opencv/opencv-python/blob/master/LICENSE-3RD-PARTY.txt).
183187

184188
### Versioning
185189

0 commit comments

Comments
 (0)