python-opencv-utils 0.1.0__tar.gz

python_opencv_utils-0.1.0/.gitignore

@@ -0,0 +1,51 @@
+# Byte-compiled / optimized files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Test / coverage / tool caches
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.tox/
+.nox/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+
+# Environment
+.env
+.python-version
+
+# Editors / IDEs / OS
+.vscode/
+.idea/
+*.swp
+.DS_Store
+Thumbs.db
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Docs build output and Zensical cache
+site/
+.cache/
+
+# Local-only helpers (e.g. logo generation), not part of the package
+.local/

python_opencv_utils-0.1.0/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-11-05
+
+First official release.
+
+### Highlights
+
+- **Drop-in replacement for `cv2`**: `import cv2u as cv` gives you all of OpenCV plus the extensions below,
+  following the official OpenCV `import cv2 as cv` convention.
+- **Typed**: type checkers and IDEs see OpenCV's own signatures through cv2u (`cv.imread`, `cv.cvtColor`, ...),
+  and every extension has type hints (`py.typed`, checked with `mypy --strict` and pyright).
+- **[Design principles](https://076923.github.io/cv2-utils/principles/)** that decide what belongs in cv2u,
+  partly enforced by tests (no extension shadows an OpenCV name; OpenCV-style naming).
+
+### Requirements
+
+- Python 3.11+ (tested on 3.11 through 3.15, and on the 3.16 pre-releases).
+- OpenCV 5.0+ (`opencv-python`), NumPy 2.0+, Pillow 10.1+. `import cv2u` raises `ImportError` if an older `cv2`
+  is installed.
+- Optional `cluster` extra (`pip install "python-opencv-utils[cluster]"`) for scikit-learn, needed by
+  `meanShiftColors`, `DBSCAN` and `clusterPoints`.
+
+### Features
+
+- `imgcodecs`
+  - `imreadEx`, `imwriteEx`: `cv.imread`/`cv.imwrite` that also work with non-ASCII (e.g. Korean) paths on Windows;
+    `imwriteEx(..., makeDirs=True)` creates missing folders.
+  - `urlread`: read an image from a URL, with `timeout` and `headers`.
+  - `toPillow`, `fromPillow`: convert to/from Pillow with the right channel order (also palette, CMYK and
+    transparent images).
+  - `imencodeBase64`, `imdecodeBase64`: images as base64 text or data URIs.
+- `imgproc`
+  - `toGray`, `toBGR`, `toBGRA`: convert from any channel count, without errors for images already in that format.
+  - `hexToBGR`, `bgrToHex`: convert between hex colors and BGR tuples.
+  - `adjustBrightnessContrast`, `adjustHSV`, `autoContrast`, `whiteBalance`: photo-style color adjustments.
+  - `sharpnessScore`, `ssim`, `diffMask`: blur detection, structural similarity and change detection.
+  - `translate`: shift an image keeping its size.
+  - `drawDashedLine`, `drawDashedRectangle`, `drawHistogram`: dashed drawing and histogram plots.
+  - `largestComponent`, `skeletonize`, `cutout`: keep the main object, thin to lines, cut out with alpha.
+  - `findContoursEx`: `cv.findContours` for any image, sorted by area, with small contours dropped.
+  - `fillHoles`, `removeSmallObjects`: binary mask clean-up.
+  - `findTemplate`: `cv.matchTemplate` as a list of non-overlapping matches.
+  - `resizeEx`: resize keeping the aspect ratio, choosing `INTER_AREA`/`INTER_LINEAR` automatically.
+  - `letterbox`: fit into a fixed size keeping the aspect ratio and pad; returns the scale and offset.
+  - `fourPointTransform`: warp a quadrilateral (corners in any order) to an upright rectangle.
+  - `autoCanny`: `cv.Canny` with thresholds chosen from the median brightness.
+  - `equalizeHistEx`: `cv.equalizeHist` for color images too, optionally with CLAHE.
+  - `unsharpMask`: unsharp-mask sharpening.
+  - `drawLabel`: detector-style box with a label tag (Unicode labels with a TrueType font), drawn in place.
+  - `overlayMask`: tint masked pixels, e.g. to visualize a segmentation.
+  - `putTextEx`: draw Unicode text (e.g. Korean) with a TrueType font.
+- `videoio`
+  - `readFrames`: iterate over video frames (with `step` and `start`); the capture is released automatically.
+  - `writeVideo`: write frames with the size, color mode and codec detected automatically.
+  - `videoInfo`: size, frame rate, frame count and duration in one call.
+  - `readFrameAt`: read a single frame by number or time.
+- `highgui`
+  - `imshowInline`: show images in Jupyter notebooks with their real colors.
+  - `imshowEx`: `cv.imshow` that shrinks images larger than the screen.
+- `core`
+  - `rotateEx`: rotate by any angle without cropping the corners.
+  - `hconcatEx`, `vconcatEx`: concatenate images of different sizes and channel counts, with optional gaps.
+  - `overlayImage`: alpha-blend a (transparent) image onto another, clipped at the borders.
+  - `montage`: arrange images in a grid.
+  - `cropEx`: crop safely when the box extends outside the image.
+  - `cropToContent`: trim a uniform border.
+  - `padToMultiple`, `padToSize`, `splitTiles`, `mergeTiles`: padding and tiling for large images and networks.
+  - `inRangeEx`: `cv.inRange` for hue ranges that wrap around, such as red.
+  - `imcolor`, `imcolorLike`, `makeGradient` (`"horizontal"`, `"vertical"` or `"raster"`).
+  - `centerPoint`, `isInside`, `cartesianToPolar`, `polarToCartesian` (with `angleInDegrees`).
+  - `gammaCorrection`, `DHEdge`.
+  - `dominantColors`, `colorQuantize`, `kmeansColors`: color palettes, posterization and deterministic color
+    k-means, built on `cv.kmeans` (no extra needed).
+  - `peakColors`: cv2u's own color clustering. It follows the peaks of the Lab color histogram, finds the number
+    of colors by itself, uses every pixel, is deterministic and needs no extra.
+  - `meanShiftColors`: color clustering that finds the number of colors by itself.
+  - `DBSCAN`, `drawDBSCAN`: color clustering in the Lab color space.
+  - `clusterPoints`: group nearby points (keypoints, detections) with DBSCAN.
+- `flag`: named constants for magic numbers that OpenCV takes without a constant of its own
+  - `FLIP_MODE_X`, `FLIP_MODE_Y`, `FLIP_MODE_XY` (`cv.flip`), `DDEPTH_SAME` (`ddepth=-1`),
+    `ALL_CONTOURS` (`cv.drawContours`), `REDUCE_TO_ROW`, `REDUCE_TO_COL` (`cv.reduce`),
+    `WAIT_FOREVER` and `KEY_ESC`, `KEY_ENTER`, `KEY_SPACE`, `KEY_TAB`, `KEY_BACKSPACE` (`cv.waitKey`).
+- Invalid input raises `ValueError` with a clear message.
+
+### Project
+
+- Documentation site built with [Zensical](https://zensical.org): <https://076923.github.io/cv2-utils/>.
+- Test suite with golden-image regression tests and coverage; CI on Linux, Windows and macOS.
+- Releases are published from GitHub Actions with PyPI trusted publishing and digital attestations.
+- `SECURITY.md`, `CODE_OF_CONDUCT.md` and `CITATION.cff`.
+
+[0.1.0]: https://github.com/076923/cv2-utils/releases/tag/v0.1.0

python_opencv_utils-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

python_opencv_utils-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+Python OpenCV Utilities
+Copyright 2021-2026 Daehee Yun
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).