python-aruco2 0.1.0__tar.gz → 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. python_aruco2-1.0.0/NOTICE +7 -0
  2. python_aruco2-1.0.0/PKG-INFO +95 -0
  3. python_aruco2-1.0.0/README.md +76 -0
  4. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/UPSTREAM.md +1 -1
  5. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/cpp/bindings.cpp +1 -1
  6. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/pyproject.toml +3 -3
  7. python_aruco2-1.0.0/vendor/aruco2/LICENSE +201 -0
  8. python_aruco2-0.1.0/LICENSE +0 -21
  9. python_aruco2-0.1.0/PKG-INFO +0 -73
  10. python_aruco2-0.1.0/README.md +0 -55
  11. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/.github/workflows/wheels.yml +0 -0
  12. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/.gitignore +0 -0
  13. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/CMakeLists.txt +0 -0
  14. {python_aruco2-0.1.0/vendor/aruco2 → python_aruco2-1.0.0}/LICENSE +0 -0
  15. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/src/aruco2/__init__.py +0 -0
  16. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/src/aruco2/__init__.pyi +0 -0
  17. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/src/aruco2/licenses/opencv-LICENSE +0 -0
  18. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/src/aruco2/licenses/pybind11-LICENSE +0 -0
  19. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/src/aruco2/py.typed +0 -0
  20. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/tests/test_binding.py +0 -0
  21. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/.gitignore +0 -0
  22. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/CMakeLists.txt +0 -0
  23. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/README.md +0 -0
  24. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/board9x5.png +0 -0
  25. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/opencl/aruco2detect.cl +0 -0
  26. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/opencv2/objdetect/aruco2.hpp +0 -0
  27. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2.cpp +0 -0
  28. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_dictionary.cpp +0 -0
  29. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_dictionary.hpp +0 -0
  30. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_fractal.cpp +0 -0
  31. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_predefined_dictionaries.hpp +0 -0
  32. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_predefined_dictionaries_alvar.hpp +0 -0
  33. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_predefined_dictionaries_apriltag.hpp +0 -0
  34. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco2_predefined_dictionaries_raruco.hpp +0 -0
  35. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco_dictionary.cpp +0 -0
  36. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/aruco_dictionary.hpp +0 -0
  37. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/predefined_dictionaries.hpp +0 -0
  38. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/predefined_dictionaries_alvar.hpp +0 -0
  39. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/src/predefined_dictionaries_apriltag.hpp +0 -0
  40. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/types.jpg +0 -0
  41. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_camera_calibration.cpp +0 -0
  42. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_detect_diamonds.cpp +0 -0
  43. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_detect_fractal.cpp +0 -0
  44. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_detect_markers.cpp +0 -0
  45. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_detect_raruco.cpp +0 -0
  46. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/aruco2_print.cpp +0 -0
  47. {python_aruco2-0.1.0 → python_aruco2-1.0.0}/vendor/aruco2/utils/cl2cpp.cmake +0 -0
@@ -0,0 +1,7 @@
1
+ python-aruco2
2
+ Copyright 2026 HITLAB contributors
3
+
4
+ This product includes software developed by:
5
+ - ArUco2 (https://github.com/rmsalinas/aruco2), Apache-2.0
6
+ - OpenCV (https://github.com/opencv/opencv), Apache-2.0
7
+ - pybind11 (https://github.com/pybind/pybind11), BSD-3-Clause
@@ -0,0 +1,95 @@
1
+ Metadata-Version: 2.4
2
+ Name: python-aruco2
3
+ Version: 1.0.0
4
+ Summary: NumPy Python bindings for rmsalinas/aruco2
5
+ License-Expression: Apache-2.0 AND BSD-3-Clause
6
+ License-File: LICENSE
7
+ License-File: NOTICE
8
+ License-File: UPSTREAM.md
9
+ License-File: src/aruco2/licenses/opencv-LICENSE
10
+ License-File: src/aruco2/licenses/pybind11-LICENSE
11
+ License-File: vendor/aruco2/LICENSE
12
+ Project-URL: Repository, https://github.com/hit-labvn/python-aruco2
13
+ Project-URL: Issues, https://github.com/hit-labvn/python-aruco2/issues
14
+ Requires-Python: >=3.10
15
+ Requires-Dist: numpy>=1.23
16
+ Provides-Extra: test
17
+ Requires-Dist: pytest>=8; extra == "test"
18
+ Description-Content-Type: text/markdown
19
+
20
+ # python-aruco2
21
+
22
+ [![PyPI](https://img.shields.io/pypi/v/python-aruco2.svg)](https://pypi.org/project/python-aruco2/)
23
+ [![Python](https://img.shields.io/pypi/pyversions/python-aruco2.svg)](https://pypi.org/project/python-aruco2/)
24
+ [![Wheels](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml/badge.svg?branch=main)](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml)
25
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
26
+
27
+ Python bindings for [ArUco2](https://github.com/rmsalinas/aruco2), a fast fiducial marker detector. Self-contained: OpenCV is linked statically, so the only runtime dependency is NumPy.
28
+
29
+ ## Features
30
+
31
+ - Marker detection for all ArUco, AprilTag, ALVAR and RArUco dictionaries
32
+ - Grid boards, diamonds and fractal markers
33
+ - Marker and board image generation, and drawing helpers
34
+ - Object/image point extraction for `cv2.solvePnP`
35
+ - Releases the GIL during detection
36
+
37
+ ## Installation
38
+
39
+ ```bash
40
+ pip install python-aruco2
41
+ ```
42
+
43
+ Prebuilt wheels are available for CPython 3.10–3.14 on Windows x64, Linux x86_64 and macOS arm64.
44
+
45
+ ## Quick start
46
+
47
+ ```python
48
+ import aruco2
49
+
50
+ image = aruco2.getFiducialMarkerImage(aruco2.DICT_6X6_250, 42)
51
+ markers = aruco2.detectFiducialMarkers(image, aruco2.DICT_6X6_250)
52
+
53
+ for marker in markers:
54
+ print(marker.id, marker.corners) # corners: float32 (4, 2), clockwise
55
+ ```
56
+
57
+ For pose estimation, pass the output of `aruco2.getSolvePnpPoints(marker, markerSize=0.05)` to `cv2.solvePnP`.
58
+
59
+ ## Notes
60
+
61
+ - Input images must be `uint8` grayscale `(H, W)` / `(H, W, 1)` or BGR `(H, W, 3)`. Convert 16-bit images first.
62
+ - Do not modify an input array while detection is running on it.
63
+ - Detection parameters default to upstream values. `DetectorParameters` is an alias of `DetectionParameters`.
64
+ - OpenCL/UMat inputs and `drawAxis` are not exposed.
65
+
66
+ ## Building from source
67
+
68
+ Requires CMake 3.24+ and a C++17 compiler (Visual Studio 2022 on Windows). The first build downloads and compiles OpenCV 4.12.0.
69
+
70
+ ```bash
71
+ pip install .
72
+ ```
73
+
74
+ To link against an existing OpenCV C++ SDK instead (the `opencv-python` wheel is not one):
75
+
76
+ ```bash
77
+ pip install . \
78
+ --config-settings cmake.define.ARUCO2_BUILD_OPENCV=OFF \
79
+ --config-settings cmake.define.OpenCV_DIR=/path/to/opencv/build
80
+ ```
81
+
82
+ On Windows, add `--config-settings cmake.define.ARUCO2_STATIC_CRT=ON` if the SDK was built with `/MT`.
83
+
84
+ ## Development
85
+
86
+ ```bash
87
+ pip install ".[test]"
88
+ pytest
89
+ ```
90
+
91
+ CI builds and tests wheels on every push and pull request. Pushing a `v*` tag publishes to PyPI.
92
+
93
+ ## License
94
+
95
+ Licensed under the [Apache License 2.0](LICENSE), the same license as the vendored ArUco2 and OpenCV sources. pybind11 is BSD-3-Clause. See [NOTICE](NOTICE) for attributions and [UPSTREAM.md](UPSTREAM.md) for upstream versions and local patches. This is an independent project, not an official ArUco2 release.
@@ -0,0 +1,76 @@
1
+ # python-aruco2
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/python-aruco2.svg)](https://pypi.org/project/python-aruco2/)
4
+ [![Python](https://img.shields.io/pypi/pyversions/python-aruco2.svg)](https://pypi.org/project/python-aruco2/)
5
+ [![Wheels](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml/badge.svg?branch=main)](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml)
6
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
7
+
8
+ Python bindings for [ArUco2](https://github.com/rmsalinas/aruco2), a fast fiducial marker detector. Self-contained: OpenCV is linked statically, so the only runtime dependency is NumPy.
9
+
10
+ ## Features
11
+
12
+ - Marker detection for all ArUco, AprilTag, ALVAR and RArUco dictionaries
13
+ - Grid boards, diamonds and fractal markers
14
+ - Marker and board image generation, and drawing helpers
15
+ - Object/image point extraction for `cv2.solvePnP`
16
+ - Releases the GIL during detection
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ pip install python-aruco2
22
+ ```
23
+
24
+ Prebuilt wheels are available for CPython 3.10–3.14 on Windows x64, Linux x86_64 and macOS arm64.
25
+
26
+ ## Quick start
27
+
28
+ ```python
29
+ import aruco2
30
+
31
+ image = aruco2.getFiducialMarkerImage(aruco2.DICT_6X6_250, 42)
32
+ markers = aruco2.detectFiducialMarkers(image, aruco2.DICT_6X6_250)
33
+
34
+ for marker in markers:
35
+ print(marker.id, marker.corners) # corners: float32 (4, 2), clockwise
36
+ ```
37
+
38
+ For pose estimation, pass the output of `aruco2.getSolvePnpPoints(marker, markerSize=0.05)` to `cv2.solvePnP`.
39
+
40
+ ## Notes
41
+
42
+ - Input images must be `uint8` grayscale `(H, W)` / `(H, W, 1)` or BGR `(H, W, 3)`. Convert 16-bit images first.
43
+ - Do not modify an input array while detection is running on it.
44
+ - Detection parameters default to upstream values. `DetectorParameters` is an alias of `DetectionParameters`.
45
+ - OpenCL/UMat inputs and `drawAxis` are not exposed.
46
+
47
+ ## Building from source
48
+
49
+ Requires CMake 3.24+ and a C++17 compiler (Visual Studio 2022 on Windows). The first build downloads and compiles OpenCV 4.12.0.
50
+
51
+ ```bash
52
+ pip install .
53
+ ```
54
+
55
+ To link against an existing OpenCV C++ SDK instead (the `opencv-python` wheel is not one):
56
+
57
+ ```bash
58
+ pip install . \
59
+ --config-settings cmake.define.ARUCO2_BUILD_OPENCV=OFF \
60
+ --config-settings cmake.define.OpenCV_DIR=/path/to/opencv/build
61
+ ```
62
+
63
+ On Windows, add `--config-settings cmake.define.ARUCO2_STATIC_CRT=ON` if the SDK was built with `/MT`.
64
+
65
+ ## Development
66
+
67
+ ```bash
68
+ pip install ".[test]"
69
+ pytest
70
+ ```
71
+
72
+ CI builds and tests wheels on every push and pull request. Pushing a `v*` tag publishes to PyPI.
73
+
74
+ ## License
75
+
76
+ Licensed under the [Apache License 2.0](LICENSE), the same license as the vendored ArUco2 and OpenCV sources. pybind11 is BSD-3-Clause. See [NOTICE](NOTICE) for attributions and [UPSTREAM.md](UPSTREAM.md) for upstream versions and local patches. This is an independent project, not an official ArUco2 release.
@@ -1,6 +1,6 @@
1
1
  # Upstream sources
2
2
 
3
- The Python binding, packaging, tests, and CI configuration are MIT-licensed; see the root LICENSE. Third-party files retain the licenses below.
3
+ The Python binding, packaging, tests, and CI configuration are licensed under Apache-2.0; see the root LICENSE and NOTICE. Third-party files retain the licenses below.
4
4
 
5
5
  ArUco2: https://github.com/rmsalinas/aruco2
6
6
  Commit: c26b030cee4292649be566092812308fa179e871
@@ -54,7 +54,7 @@ template <typename T, typename F> py::array draw(const py::array &input, const s
54
54
  }
55
55
  PYBIND11_MODULE(_native, m) {
56
56
  m.doc() = "Standalone NumPy bindings for ArUco2; detection releases the Python GIL";
57
- m.attr("__version__") = "0.1.0";
57
+ m.attr("__version__") = "1.0.0";
58
58
  m.attr("upstream_commit") = "c26b030cee4292649be566092812308fa179e871";
59
59
  m.attr("opencv_version") = CV_VERSION;
60
60
  auto dict = py::enum_<a::DictionaryType>(m, "DictionaryType");
@@ -4,12 +4,12 @@ build-backend = "scikit_build_core.build"
4
4
 
5
5
  [project]
6
6
  name = "python-aruco2"
7
- version = "0.1.0"
7
+ version = "1.0.0"
8
8
  description = "NumPy Python bindings for rmsalinas/aruco2"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
11
- license = "MIT"
12
- license-files = ["LICENSE", "UPSTREAM.md", "vendor/aruco2/LICENSE", "src/aruco2/licenses/*"]
11
+ license = "Apache-2.0 AND BSD-3-Clause"
12
+ license-files = ["LICENSE", "NOTICE", "UPSTREAM.md", "vendor/aruco2/LICENSE", "src/aruco2/licenses/*"]
13
13
  dependencies = ["numpy>=1.23"]
14
14
 
15
15
  [project.urls]
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 HITLAB contributors
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,73 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: python-aruco2
3
- Version: 0.1.0
4
- Summary: NumPy Python bindings for rmsalinas/aruco2
5
- License-Expression: MIT
6
- License-File: LICENSE
7
- License-File: UPSTREAM.md
8
- License-File: src/aruco2/licenses/opencv-LICENSE
9
- License-File: src/aruco2/licenses/pybind11-LICENSE
10
- License-File: vendor/aruco2/LICENSE
11
- Project-URL: Repository, https://github.com/hit-labvn/python-aruco2
12
- Project-URL: Issues, https://github.com/hit-labvn/python-aruco2/issues
13
- Requires-Python: >=3.10
14
- Requires-Dist: numpy>=1.23
15
- Provides-Extra: test
16
- Requires-Dist: pytest>=8; extra == "test"
17
- Description-Content-Type: text/markdown
18
-
19
- # python-aruco2
20
-
21
- [![Wheels](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml/badge.svg?branch=main)](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml)
22
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
23
-
24
- Standalone Python/NumPy bindings for rmsalinas/aruco2. Distribution: `python-aruco2`; import: `aruco2`.
25
-
26
- ## Build on Windows
27
-
28
- Requires Python 3.10+, CMake 3.24+ and Visual Studio 2022 with Desktop development with C++.
29
-
30
- ```powershell
31
- uv venv --python 3.12 .venv
32
- uv pip install --python .venv/Scripts/python.exe ".[test]"
33
- .venv/Scripts/python.exe -m pytest
34
- ```
35
-
36
- The first build downloads OpenCV 4.12.0 and compiles private static CPU libraries. No cv2 installation or OpenCV DLL search path is needed. Internet is needed for build dependencies and OpenCV on the first build. The runtime depends only on NumPy and the normal Microsoft Visual C++ runtime. The same CMake project is used for Linux and macOS wheel builds in CI.
37
-
38
- To use an existing OpenCV C++ SDK instead:
39
-
40
- ```powershell
41
- uv pip install . --config-settings "cmake.define.ARUCO2_BUILD_OPENCV=OFF" --config-settings "cmake.define.OpenCV_DIR=C:/opencv/build"
42
- ```
43
-
44
- For an external Windows SDK compiled with /MT, also pass `--config-settings "cmake.define.ARUCO2_STATIC_CRT=ON"`. With an external shared SDK, distributing its runtime libraries is your responsibility. The opencv-python wheel does not provide a C++ SDK.
45
-
46
- ## Usage
47
-
48
- ```python
49
- import aruco2
50
- import numpy as np
51
-
52
- image = aruco2.getFiducialMarkerImage(aruco2.DICT_6X6_250, 42)
53
- markers = aruco2.detectFiducialMarkers(image, aruco2.DICT_6X6_250)
54
- for marker in markers:
55
- print(marker.id, marker.corners) # float32 (4, 2), clockwise
56
- object_points, image_points = aruco2.getSolvePnpPoints(marker, markerSize=0.05)
57
- # Pass these arrays to cv2.solvePnP if pose estimation is needed.
58
- annotated = aruco2.drawFiducialMarkers(np.repeat(image[..., None], 3, axis=2), markers)
59
- ```
60
-
61
- Inputs must be uint8 grayscale (H,W), (H,W,1), or BGR (H,W,3). Noncontiguous inputs are copied; 16-bit images must be explicitly converted by the caller. Detection releases the GIL; callers must not mutate input arrays concurrently. Output arrays own their memory. Drawing returns a new image and does not mutate its input. Parameters use upstream defaults, including strict error correction. `DetectionParameters` is the actual upstream name; `DetectorParameters` is also accepted as an alias.
62
-
63
- Exposes single/multiple dictionary detection, grid boards (including custom IDs), diamonds, fractals, RArUco, generators, drawing, all dictionary/fractal constants, and solvePnP point extraction. This initial binding uses CPU Mat inputs; OpenCL/UMat and drawAxis are not exposed.
64
-
65
- ## Continuous integration
66
-
67
- GitHub Actions builds and tests CPython 3.10 through 3.14 wheels for Windows x64, Linux x86_64 (manylinux), and macOS Apple Silicon on pushes, pull requests, and manual runs. Download wheels from the artifacts of a successful [Wheels workflow run](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml). A separate job builds the source archive. Version tags (`v*`) publish all distributions to PyPI after every build and test succeeds, using the `pypi` GitHub environment and PyPI Trusted Publishing. CI tests the installed wheel rather than importing the source tree.
68
-
69
- ## Source and licensing
70
-
71
- The binding code is licensed under **MIT**. Vendored ArUco2 and OpenCV retain their Apache-2.0 licenses; pybind11 retains its BSD license. MIT does not replace third-party licenses.
72
-
73
- Upstream is vendored at commit `c26b030cee4292649be566092812308fa179e871`. See `UPSTREAM.md`, `LICENSE` and `vendor/aruco2/LICENSE`. This is an independent binding project, not an official upstream Python release.
@@ -1,55 +0,0 @@
1
- # python-aruco2
2
-
3
- [![Wheels](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml/badge.svg?branch=main)](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
5
-
6
- Standalone Python/NumPy bindings for rmsalinas/aruco2. Distribution: `python-aruco2`; import: `aruco2`.
7
-
8
- ## Build on Windows
9
-
10
- Requires Python 3.10+, CMake 3.24+ and Visual Studio 2022 with Desktop development with C++.
11
-
12
- ```powershell
13
- uv venv --python 3.12 .venv
14
- uv pip install --python .venv/Scripts/python.exe ".[test]"
15
- .venv/Scripts/python.exe -m pytest
16
- ```
17
-
18
- The first build downloads OpenCV 4.12.0 and compiles private static CPU libraries. No cv2 installation or OpenCV DLL search path is needed. Internet is needed for build dependencies and OpenCV on the first build. The runtime depends only on NumPy and the normal Microsoft Visual C++ runtime. The same CMake project is used for Linux and macOS wheel builds in CI.
19
-
20
- To use an existing OpenCV C++ SDK instead:
21
-
22
- ```powershell
23
- uv pip install . --config-settings "cmake.define.ARUCO2_BUILD_OPENCV=OFF" --config-settings "cmake.define.OpenCV_DIR=C:/opencv/build"
24
- ```
25
-
26
- For an external Windows SDK compiled with /MT, also pass `--config-settings "cmake.define.ARUCO2_STATIC_CRT=ON"`. With an external shared SDK, distributing its runtime libraries is your responsibility. The opencv-python wheel does not provide a C++ SDK.
27
-
28
- ## Usage
29
-
30
- ```python
31
- import aruco2
32
- import numpy as np
33
-
34
- image = aruco2.getFiducialMarkerImage(aruco2.DICT_6X6_250, 42)
35
- markers = aruco2.detectFiducialMarkers(image, aruco2.DICT_6X6_250)
36
- for marker in markers:
37
- print(marker.id, marker.corners) # float32 (4, 2), clockwise
38
- object_points, image_points = aruco2.getSolvePnpPoints(marker, markerSize=0.05)
39
- # Pass these arrays to cv2.solvePnP if pose estimation is needed.
40
- annotated = aruco2.drawFiducialMarkers(np.repeat(image[..., None], 3, axis=2), markers)
41
- ```
42
-
43
- Inputs must be uint8 grayscale (H,W), (H,W,1), or BGR (H,W,3). Noncontiguous inputs are copied; 16-bit images must be explicitly converted by the caller. Detection releases the GIL; callers must not mutate input arrays concurrently. Output arrays own their memory. Drawing returns a new image and does not mutate its input. Parameters use upstream defaults, including strict error correction. `DetectionParameters` is the actual upstream name; `DetectorParameters` is also accepted as an alias.
44
-
45
- Exposes single/multiple dictionary detection, grid boards (including custom IDs), diamonds, fractals, RArUco, generators, drawing, all dictionary/fractal constants, and solvePnP point extraction. This initial binding uses CPU Mat inputs; OpenCL/UMat and drawAxis are not exposed.
46
-
47
- ## Continuous integration
48
-
49
- GitHub Actions builds and tests CPython 3.10 through 3.14 wheels for Windows x64, Linux x86_64 (manylinux), and macOS Apple Silicon on pushes, pull requests, and manual runs. Download wheels from the artifacts of a successful [Wheels workflow run](https://github.com/hit-labvn/python-aruco2/actions/workflows/wheels.yml). A separate job builds the source archive. Version tags (`v*`) publish all distributions to PyPI after every build and test succeeds, using the `pypi` GitHub environment and PyPI Trusted Publishing. CI tests the installed wheel rather than importing the source tree.
50
-
51
- ## Source and licensing
52
-
53
- The binding code is licensed under **MIT**. Vendored ArUco2 and OpenCV retain their Apache-2.0 licenses; pybind11 retains its BSD license. MIT does not replace third-party licenses.
54
-
55
- Upstream is vendored at commit `c26b030cee4292649be566092812308fa179e871`. See `UPSTREAM.md`, `LICENSE` and `vendor/aruco2/LICENSE`. This is an independent binding project, not an official upstream Python release.
File without changes