| Name | opencv-stubs JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | None |
| Summary | Unofficial stubs for the opencv-python package. |
| upload_time | 2024-07-04 04:20:02 |
| maintainer | None |
| docs_url | None |
| author | Bagard Hoel |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
opencv
stubs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenCV stubs
[](https://pypi.org/project/opencv-stubs)
[](https://pypi.org/project/opencv-stubs)
[](https://pypi.org/project/opencv-stubs)
[](https://pypistats.org/packages/opencv-stubs)
[](https://opensource.org/licenses/MIT)
Unofficial python stubs for the opencv-python package.
Official OpenCV stubs now exist (in OpenCV>=4.8, cf [this issue](https://github.com/opencv/opencv/issues/14590) and [this PR](https://github.com/opencv/opencv/pull/20370)), so this repo was archived from 2023/03/27 to 2024/04/13.\
However I found the official stubs unhelpfull when it came to type hinting, so I'm un-archiving the repo.
This package includes all the functions, classes and constants (please open an issue if you find a missing one).\
For some functions, OpenCV may handle more types than defined in this package. If you would like a type/function to be added or modified, please open an issue or a PR. There may also be a few errors as some types have been added programmatically. Please open an issue/PR if you see one.
The stubs include the docstrings as they are otherwise not available in IDEs (as far as I know).
## Installation
The package is available on pypi [here](https://pypi.org/project/opencv-stubs/), you can install it with:
```
pip install opencv-stubs
```
The dependency on opencv is optional, and can be accessed with:
- `pip install opencv-stubs[opencv]`
- `pip install opencv-stubs[opencv-contrib]`
- `pip install opencv-stubs[opencv-headless]`
## Acknowledgements
A stub file with opencv functions can be found on the [Microsoft stubs repo](https://github.com/microsoft/python-type-stubs/tree/main/cv2). This package reused those functions (with some added typing).
## TODO:
- [ ] Do something about `cv2.gapi.cv`, `cv2.utils.cv2` and `cv2.mat_wrapper.cv` (do not duplicate everything if possible).
- [ ] Handle cases like `cv2.misc.version.cv2.misc.version.cv2.misc.get_ocv_version()`.
- [ ] Only include the `opencv-contrib` specific stubs when using `opencv-stubs[opencv-contrib]`.
Raw data
{
"_id": null,
"home_page": null,
"name": "opencv-stubs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "OpenCV, stubs",
"author": "Bagard Hoel",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5d/d3/cebbcce9083345047818190ae1b354166812b3687e104aefc0bb3c430580/opencv_stubs-0.0.10.tar.gz",
"platform": null,
"description": "# OpenCV stubs\n\n[](https://pypi.org/project/opencv-stubs)\n[](https://pypi.org/project/opencv-stubs)\n[](https://pypi.org/project/opencv-stubs)\n[](https://pypistats.org/packages/opencv-stubs)\n[](https://opensource.org/licenses/MIT)\n\n\nUnofficial python stubs for the opencv-python package.\n\nOfficial OpenCV stubs now exist (in OpenCV>=4.8, cf [this issue](https://github.com/opencv/opencv/issues/14590) and [this PR](https://github.com/opencv/opencv/pull/20370)), so this repo was archived from 2023/03/27 to 2024/04/13.\\\nHowever I found the official stubs unhelpfull when it came to type hinting, so I'm un-archiving the repo.\n\nThis package includes all the functions, classes and constants (please open an issue if you find a missing one).\\\nFor some functions, OpenCV may handle more types than defined in this package. If you would like a type/function to be added or modified, please open an issue or a PR. There may also be a few errors as some types have been added programmatically. Please open an issue/PR if you see one.\n\nThe stubs include the docstrings as they are otherwise not available in IDEs (as far as I know).\n\n## Installation\n\nThe package is available on pypi [here](https://pypi.org/project/opencv-stubs/), you can install it with:\n\n```\npip install opencv-stubs\n```\n\nThe dependency on opencv is optional, and can be accessed with:\n- `pip install opencv-stubs[opencv]`\n- `pip install opencv-stubs[opencv-contrib]`\n- `pip install opencv-stubs[opencv-headless]`\n\n\n## Acknowledgements\n\nA stub file with opencv functions can be found on the [Microsoft stubs repo](https://github.com/microsoft/python-type-stubs/tree/main/cv2). This package reused those functions (with some added typing).\n\n## TODO:\n- [ ] Do something about `cv2.gapi.cv`, `cv2.utils.cv2` and `cv2.mat_wrapper.cv` (do not duplicate everything if possible).\n- [ ] Handle cases like `cv2.misc.version.cv2.misc.version.cv2.misc.get_ocv_version()`.\n- [ ] Only include the `opencv-contrib` specific stubs when using `opencv-stubs[opencv-contrib]`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Unofficial stubs for the opencv-python package.",
"version": "0.0.10",
"project_urls": {
"Bug Tracker": "https://github.com/hoel-bagard/opencv-stubs/issues",
"Homepage": "https://github.com/hoel-bagard/opencv-stubs"
},
"split_keywords": [
"opencv",
" stubs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "69d2bde334d5d9a95dbda9038ae1c682529d66f4db554b0890e73881106fa7f4",
"md5": "5d9ce01a5a2d58dbe7cb8a49d2d20820",
"sha256": "470f979b7403e1766857fd21922f292a9b84450da90d2e498d63c6b59148d87e"
},
"downloads": -1,
"filename": "opencv_stubs-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d9ce01a5a2d58dbe7cb8a49d2d20820",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 362599,
"upload_time": "2024-07-04T04:20:05",
"upload_time_iso_8601": "2024-07-04T04:20:05.713944Z",
"url": "https://files.pythonhosted.org/packages/69/d2/bde334d5d9a95dbda9038ae1c682529d66f4db554b0890e73881106fa7f4/opencv_stubs-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5dd3cebbcce9083345047818190ae1b354166812b3687e104aefc0bb3c430580",
"md5": "50849e03bbf45268342bc055b754485a",
"sha256": "d739c5e7b0628838e1a9a7dc88f9eb1b2c0a9df14d5ae879f9615788a9de1436"
},
"downloads": -1,
"filename": "opencv_stubs-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "50849e03bbf45268342bc055b754485a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 341213,
"upload_time": "2024-07-04T04:20:02",
"upload_time_iso_8601": "2024-07-04T04:20:02.957196Z",
"url": "https://files.pythonhosted.org/packages/5d/d3/cebbcce9083345047818190ae1b354166812b3687e104aefc0bb3c430580/opencv_stubs-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 04:20:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hoel-bagard",
"github_project": "opencv-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "opencv-stubs"
}
