vws-python 2026.8.14__py3-none-any.whl

vws_python-2026.8.14.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: vws-python
+Version: 2026.8.14
+Summary: Interact with the Vuforia Web Services (VWS) API.
+Author-email: Adam Dangoor <adamdangoor@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://vws-python.github.io/vws-python/
+Project-URL: Source, https://github.com/VWS-Python/vws-python
+Keywords: client,vuforia,vws
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: beartype>=0.22.9
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: urllib3>=2.2.3
+Requires-Dist: vws-auth-tools>=2024.7.12
+Provides-Extra: dev
+Requires-Dist: actionlint-py==1.7.12.24; extra == "dev"
+Requires-Dist: check-manifest==0.51; extra == "dev"
+Requires-Dist: deptry==0.25.1; extra == "dev"
+Requires-Dist: doc8==2.0.0; extra == "dev"
+Requires-Dist: doccmd==2026.7.19; extra == "dev"
+Requires-Dist: freezegun==1.5.5; extra == "dev"
+Requires-Dist: furo==2025.12.19; extra == "dev"
+Requires-Dist: interrogate==1.7.0; extra == "dev"
+Requires-Dist: mypy[faster-cache]==2.3.0; extra == "dev"
+Requires-Dist: mypy-strict-kwargs==2026.7.19.1; extra == "dev"
+Requires-Dist: no-defaults==2.1.0; extra == "dev"
+Requires-Dist: prek==0.4.13; extra == "dev"
+Requires-Dist: pydocstringformatter==1.0.0; extra == "dev"
+Requires-Dist: pydocstyle==6.3; extra == "dev"
+Requires-Dist: pygments==2.20.0; extra == "dev"
+Requires-Dist: pylint[spelling]==4.0.7; extra == "dev"
+Requires-Dist: pylint-per-file-ignores==3.2.1; extra == "dev"
+Requires-Dist: pyproject-fmt==2.27.0; extra == "dev"
+Requires-Dist: pyrefly==1.2.0; extra == "dev"
+Requires-Dist: pyright==1.1.411; extra == "dev"
+Requires-Dist: pyroma==5.0.1; extra == "dev"
+Requires-Dist: pytest==9.1.1; extra == "dev"
+Requires-Dist: pytest-asyncio==1.4.0; extra == "dev"
+Requires-Dist: pytest-beartype-tests==2026.4.26; extra == "dev"
+Requires-Dist: pytest-cov==7.1.0; extra == "dev"
+Requires-Dist: pyyaml==6.0.3; extra == "dev"
+Requires-Dist: ruff==0.16.2; extra == "dev"
+Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
+Requires-Dist: shfmt-py==4.0.0; extra == "dev"
+Requires-Dist: sphinx==9.1.0; extra == "dev"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
+Requires-Dist: sphinx-lint==1.0.2; extra == "dev"
+Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2026.8.5; extra == "dev"
+Requires-Dist: sphinxcontrib-spelling==8.0.2; extra == "dev"
+Requires-Dist: sphinxcontrib-towncrier==0.5.0a0; extra == "dev"
+Requires-Dist: strict-kwargs==2026.7.24; extra == "dev"
+Requires-Dist: sybil==10.1.0; extra == "dev"
+Requires-Dist: towncrier==25.8.0; extra == "dev"
+Requires-Dist: ty==0.0.70; extra == "dev"
+Requires-Dist: types-requests==2.33.0.20260712; extra == "dev"
+Requires-Dist: vale==3.13.0.0; extra == "dev"
+Requires-Dist: vulture==2.16; extra == "dev"
+Requires-Dist: vws-python-mock==2026.8.14; extra == "dev"
+Requires-Dist: vws-test-fixtures==2023.3.5; extra == "dev"
+Requires-Dist: yamlfix==1.19.1; extra == "dev"
+Requires-Dist: zizmor==1.29.0; extra == "dev"
+Provides-Extra: release
+Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
+Requires-Dist: towncrier==25.8.0; extra == "release"
+Dynamic: license-file
+
+|Build Status| |PyPI|
+
+vws-python
+==========
+
+Python library for the Vuforia Web Services (VWS) API and the Vuforia
+Web Query API.
+
+Installation
+------------
+
+.. code-block:: shell
+
+   pip install vws-python
+
+This is tested on Python |minimum-python-version|\+. Get in touch with
+``adamdangoor@gmail.com`` if you would like to use this with another
+language.
+
+Getting Started
+---------------
+
+.. code-block:: python
+
+   """Add a target to VWS and then query it."""
+
+   import os
+   import pathlib
+   import uuid
+
+   from vws import VWS, CloudRecoService
+
+   server_access_key = os.environ["VWS_SERVER_ACCESS_KEY"]
+   server_secret_key = os.environ["VWS_SERVER_SECRET_KEY"]
+   client_access_key = os.environ["VWS_CLIENT_ACCESS_KEY"]
+   client_secret_key = os.environ["VWS_CLIENT_SECRET_KEY"]
+
+   vws_client = VWS(
+       server_access_key=server_access_key,
+       server_secret_key=server_secret_key,
+   )
+
+   cloud_reco_client = CloudRecoService(
+       client_access_key=client_access_key,
+       client_secret_key=client_secret_key,
+   )
+
+   name = "my_image_name_" + uuid.uuid4().hex
+
+   image = pathlib.Path("high_quality_image.jpg")
+   with image.open(mode="rb") as my_image_file:
+       target_id = vws_client.add_target(
+           name=name,
+           width=1,
+           image=my_image_file,
+           active_flag=True,
+           application_metadata=None,
+       )
+
+   vws_client.wait_for_target_processed(target_id=target_id)
+
+   with image.open(mode="rb") as my_image_file:
+       matching_targets = cloud_reco_client.query(image=my_image_file)
+
+   assert matching_targets[0].target_id == target_id
+
+Full Documentation
+------------------
+
+See the `full documentation <https://vws-python.github.io/vws-python/>`__.
+
+.. |Build Status| image:: https://github.com/VWS-Python/vws-python/actions/workflows/ci.yml/badge.svg?branch=main
+   :target: https://github.com/VWS-Python/vws-python/actions
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
+   :target: https://badge.fury.io/py/VWS-Python
+.. |minimum-python-version| replace:: 3.14

vws_python-2026.8.14.dist-info/RECORD

@@ -0,0 +1,32 @@
+vws/__init__.py,sha256=ibV0RiclPFc481Fsr8dBfmwNsYfTX5D4TP46filC_Z0,590
+vws/_async_vws_request.py,sha256=3HVE2GHIixjtDEuyDS7Ox4zFtHbLh6Vt8lWQJq8l8WA,2305
+vws/_image_utils.py,sha256=5HAg7DYJ-UwnEg6267LgwGsGppf12kLXTl0tkwTJ8kI,395
+vws/_model_targets.py,sha256=MhsIUpC2BCftt-2qz7bCsePY7dhIlY47qD_0D3atL7k,10046
+vws/_reco_counts.py,sha256=xbucj0-7QmWI9Z8ix9Bm3w8phFcAijiu_MsFhcQe6q0,2635
+vws/_vws_request.py,sha256=y9x9OhLGY4xZBYBq41w8sg_G1SwMcR7KTgGtG3dYbyA,2246
+vws/async_model_target_service.py,sha256=4jnVRTPyjiineGg_6PIe1hOocMCHjYxjpqjKXWZxLaQ,13428
+vws/async_query.py,sha256=acT_2ulUiek_TdHALRSXDObOR8gZZKmTokMi56orBqE,8225
+vws/async_vumark_service.py,sha256=oBjVE9TTbPlNWjh50otw7b7Ib6xuzJjpZBEjn6r5Vfk,6087
+vws/async_vws.py,sha256=TEqvKOjKIPn1w7T1XQTDXyuGJjSFZ9Fw2Tkz5wP3880,29530
+vws/include_target_data.py,sha256=Ba8hqLJ9iPlgjRw_33X_ps9XemfJjMpS1mRL2rVnuf0,371
+vws/model_target_datasets.py,sha256=kRmieCrc7CrR0pAn7Jd01vJ5UvNnVBP7FA7MDVBwIoY,3429
+vws/model_target_service.py,sha256=NcCVRiBdHQGSYFd2TQOCt3q5g926m3CkmrLRnhE_VMw,12802
+vws/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vws/query.py,sha256=Iikjx-X9BDrb1_E20rA6tJ7cIM0o08ebaeNwY6Hdvhk,7532
+vws/reports.py,sha256=BlNHg_EzDqlJ-VArHL8ihTYXUSWdoDYkIaskDhJwlLc,11723
+vws/response.py,sha256=G-1DvKcf43-WcQvdjm4mCsCvolQh0UYJPMSHJpkU0Wk,370
+vws/transports.py,sha256=rV8iqom9dDlDP5TcjPHIjRbF7g8paokE2JMwrJ2Bzuw,9277
+vws/vumark_accept.py,sha256=y-dzOrxFZAim1qkq0l7Ma_4PLfxh74lTTl_hrRJFdJ4,361
+vws/vumark_service.py,sha256=q0VlmkX4gPbvRzmWqV1B9vMLdrBhq9Pt_qWT026mpzA,5546
+vws/vws.py,sha256=jwNxJbB0YViq_raYf8OnaA6ed2iOlg1DBnylplgN4kE,28524
+vws/exceptions/__init__.py,sha256=szlmtfycXsukt4BVjOAcJUn0-naBMOF9_AGtYE8yh7g,48
+vws/exceptions/base_exceptions.py,sha256=LfI1BGXcOPlvqQj0jdEqgJquN_T-RZ0xIAJWq74KkJU,2063
+vws/exceptions/cloud_reco_exceptions.py,sha256=9t8tmSczxMis4yO4TYCdfyY0afEJioRVLKuK-tMcoEY,1038
+vws/exceptions/custom_exceptions.py,sha256=jziPxIDYqskRd2lM94Xc4ZR3913O2oZxIfJIl3vM7tY,2903
+vws/exceptions/model_target_exceptions.py,sha256=r_e885M2hqpR0rAk8XyPhxs-BASLxr9zHtCITxdZ1Ao,5854
+vws/exceptions/vws_exceptions.py,sha256=n8ISlRwDJEx-9qo_pWkVVhIYHslMjhvadMzJzwCtB4Q,7080
+vws_python-2026.8.14.dist-info/licenses/LICENSE,sha256=N3qm7laipxyuXkWpYllj89AObvPbtWgoABmaKfhQYL4,1069
+vws_python-2026.8.14.dist-info/METADATA,sha256=JsTVkFrPGXI0Avb88SodVAPkw51Ub0rn3XeGfg31-Uc,5564
+vws_python-2026.8.14.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+vws_python-2026.8.14.dist-info/top_level.txt,sha256=b0Qp9MD6LOYXh3Cv9AyXNpT0KY9QnOt2Yb7RGtFeYd0,4
+vws_python-2026.8.14.dist-info/RECORD,,

vws_python-2026.8.14.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

vws_python-2026.8.14.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Adam Dangoor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vws_python-2026.8.14.dist-info/top_level.txt

@@ -0,0 +1 @@
+vws