vws-python-mock 2026.8.4__py3-none-any.whl

vws_python_mock-2026.8.4.dist-info/METADATA

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: vws-python-mock
+Version: 2026.8.4
+Summary: A mock for 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-mock/
+Project-URL: Source, https://github.com/VWS-Python/vws-python-mock
+Keywords: client,fake,mock,vuforia,vws
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Pytest
+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: flask>=3.0.3
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pillow>=11.0.0
+Requires-Dist: piq>=0.8.0
+Requires-Dist: pydantic-settings>=2.6.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: responses>=0.25.3
+Requires-Dist: respx>=0.21.0
+Requires-Dist: torch>=2.5.1
+Requires-Dist: torchmetrics>=1.5.1
+Requires-Dist: torchvision>=0.20.1
+Requires-Dist: tzdata; sys_platform == "win32"
+Requires-Dist: vws-auth-tools>=2024.7.12
+Requires-Dist: werkzeug>=3.1.2
+Provides-Extra: dev
+Requires-Dist: actionlint-py==1.7.12.24; extra == "dev"
+Requires-Dist: check-manifest==0.51; extra == "dev"
+Requires-Dist: check-wheel-contents==0.6.3; extra == "dev"
+Requires-Dist: coverage==7.15.2; extra == "dev"
+Requires-Dist: deptry==0.25.1; extra == "dev"
+Requires-Dist: dirty-equals==0.11; extra == "dev"
+Requires-Dist: doc8==2.0.0; extra == "dev"
+Requires-Dist: doccmd==2026.7.19; extra == "dev"
+Requires-Dist: docker==7.2.0; 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: prek==0.4.11; extra == "dev"
+Requires-Dist: pydocstringformatter==1.0.0; extra == "dev"
+Requires-Dist: pydocstyle==6.3; extra == "dev"
+Requires-Dist: pylint[spelling]==4.0.6; extra == "dev"
+Requires-Dist: pylint-per-file-ignores==3.2.1; extra == "dev"
+Requires-Dist: pyproject-fmt==2.26.0; extra == "dev"
+Requires-Dist: pyrefly==1.1.1; 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-beartype-tests==2026.4.26; extra == "dev"
+Requires-Dist: pytest-retry==1.7.0; extra == "dev"
+Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
+Requires-Dist: pyyaml==6.0.3; extra == "dev"
+Requires-Dist: requests-mock-flask==2026.4.2; extra == "dev"
+Requires-Dist: ruff==0.16.1; 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-paramlinks==0.6; extra == "dev"
+Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2026.6.17; extra == "dev"
+Requires-Dist: sphinx-toolbox==4.3.0; extra == "dev"
+Requires-Dist: sphinxcontrib-httpdomain==2.0.0; 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: tenacity==9.1.4; extra == "dev"
+Requires-Dist: towncrier==25.8.0; extra == "dev"
+Requires-Dist: ty==0.0.65; extra == "dev"
+Requires-Dist: types-docker==7.2.0.20260728; extra == "dev"
+Requires-Dist: types-pyyaml==6.0.12.20260724; extra == "dev"
+Requires-Dist: types-requests==2.33.0.20260712; extra == "dev"
+Requires-Dist: urllib3==2.7.0; extra == "dev"
+Requires-Dist: vulture==2.16; extra == "dev"
+Requires-Dist: vws-python==2026.2.25.1; extra == "dev"
+Requires-Dist: vws-test-fixtures==2023.3.5; extra == "dev"
+Requires-Dist: vws-web-tools==2026.5.21; extra == "dev"
+Requires-Dist: yamlfix==1.19.1; extra == "dev"
+Requires-Dist: zizmor==1.28.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 Mock
+========
+
+.. contents::
+   :local:
+
+Mock for the Vuforia Web Services (VWS) API, the Vuforia Web Query API, and the Model Target Web API.
+
+Mocking calls made to Vuforia
+------------------------------
+
+``MockVWS`` intercepts requests made with `requests`_ or `httpx`_.
+
+.. code-block:: shell
+
+    pip install vws-python-mock
+
+This requires Python |minimum-python-version|\+.
+
+.. code-block:: python
+
+    """Make a request to the Vuforia Web Services API mock."""
+
+    import requests
+
+    from mock_vws import MockVWS
+    from mock_vws.database import CloudDatabase
+
+    with MockVWS() as mock:
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
+        # This will use the Vuforia mock.
+        requests.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+``MockVWS`` also intercepts `httpx`_ requests:
+
+.. code-block:: python
+
+    """Make a request to the Vuforia Web Services API mock using httpx."""
+
+    import httpx
+
+    from mock_vws import MockVWS
+    from mock_vws.database import CloudDatabase
+
+    with MockVWS() as mock:
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
+        # This will use the Vuforia mock.
+        httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+By default, an exception will be raised if any requests to unmocked addresses are made.
+
+.. _requests: https://pypi.org/project/requests/
+.. _httpx: https://pypi.org/project/httpx/
+
+Using Docker to mock calls to Vuforia from any language
+-------------------------------------------------------
+
+It is possible run a Mock VWS instance using Docker containers.
+
+This allows you to run tests against a mock VWS instance regardless of the language or tooling you are using.
+
+See the `the instructions <https://vws-python.github.io/vws-python-mock/docker.html>`__ for how to do this.
+
+Full documentation
+------------------
+
+See the `full documentation <https://vws-python.github.io/vws-python-mock/>`__.
+This includes details on how to use the mock, options, and details of the differences between the mock and the real Vuforia Web Services.
+
+
+.. |Build Status| image:: https://github.com/VWS-Python/vws-python-mock/actions/workflows/test.yml/badge.svg?branch=main
+   :target: https://github.com/VWS-Python/vws-python-mock/actions
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python-Mock.svg
+    :target: https://badge.fury.io/py/VWS-Python-Mock
+.. |minimum-python-version| replace:: 3.14

vws_python_mock-2026.8.4.dist-info/RECORD

@@ -0,0 +1,62 @@
+mock_vws/__init__.py,sha256=0uK9QpC7GXd25R84zqUkCYLLWirQBTwTZe567E2-rSk,228
+mock_vws/_base64_decoding.py,sha256=BYq4RvzGNancdBNmysT-25AiljZloffAPVW_MDECP-I,945
+mock_vws/_constants.py,sha256=hg4JfJzvN_DSvANmZPQCiv_7-onJ_YvTdDlqTDnnDxE,2746
+mock_vws/_database_matchers.py,sha256=i7BlpLUtuCKlcXpxl6Er9ZG-bz_uyEVLZuopr1uct_8,3382
+mock_vws/_mock_common.py,sha256=pga7lmAW7pTiPTPK6TphNaTrL0WeEwj0pqlerAomoEc,1776
+mock_vws/_model_target_web_api.py,sha256=s5i1LMDy9PqaEAc7E1jelmCaQpUPljt6SDvyzybArzs,14628
+mock_vws/_query_tools.py,sha256=rhiHj_utUV_rAl9_kMrIkLJcLVlFZPBnt7UvvOWknOc,4151
+mock_vws/database.py,sha256=4AlZsPBJKt4rdi-OL7urdgDPWuUiP32uxzLlN1DYA_Y,9113
+mock_vws/database_type.py,sha256=mHsED71JwtS5EpuhR43SJCo9PL9mzMYFNYTUn-pzmak,232
+mock_vws/image_matchers.py,sha256=F-kuc7t8dEMdGDa87FFBWXVH8elvsbO_adHpzePScLI,4020
+mock_vws/model_target.py,sha256=DBbAvLAo_3oLOcxckbEFj4-5zkCmB9I2URSq3MGp0Pc,2411
+mock_vws/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mock_vws/states.py,sha256=KNuUXSWsU6cEJ1SvwxVsZySXq-93i9bl457RxSKefAs,396
+mock_vws/target.py,sha256=vbD3D_TpNV_nreSwFWcmQVJzxEkrOpDEi0vhqSmFAyA,9733
+mock_vws/target_manager.py,sha256=oM9XiS5mEdBpzHZcGiEBcKTCGgCpXs2gb2dBE6GzitY,5969
+mock_vws/target_raters.py,sha256=h9Y499jlpAWPsKbIZTrqENLyN2FGJOzZ6iRJNMt8NPo,3252
+mock_vws/_flask_server/Dockerfile,sha256=vxWYQIRa-4aLVYN5fNnNE1OPl912iMHfUjGuEp5htYw,1098
+mock_vws/_flask_server/__init__.py,sha256=ttgZ5WNWb3Oeyd1lt21Mt2zkVE1oqBXJCw-SDp3dIj4,53
+mock_vws/_flask_server/healthcheck.py,sha256=vJ_18739e72SU20SEEM3BxfFbyJ4kq9aLa09WcDOlxg,759
+mock_vws/_flask_server/target_manager.py,sha256=nN4CK6F19SR_UtNok53q9dIIMRQIOhnEhOIA7wRiRSk,13620
+mock_vws/_flask_server/vwq.py,sha256=ZmxW3AWK7a2R0XeHay7X2pvGioznpYqxKwAbv6XrfqY,5223
+mock_vws/_flask_server/vws.py,sha256=l3VTTnXsOxrHLQkMBpHSqLnhTag3GnsV3TEv8zMDteM,30078
+mock_vws/_query_validators/__init__.py,sha256=L8Co-8A5JNixWJqD4cnj8qF-AR1yI8v1VTxJyLSosIY,4093
+mock_vws/_query_validators/accept_header_validators.py,sha256=a6aAVGcU8HH5WYg6tHZ8ZLOMJw6_pRo9_dVv5shnzrc,813
+mock_vws/_query_validators/auth_validators.py,sha256=XVqC6nbsX_0zIrOYwVxn0uCcMZrHDBjotHrC6YP9SfE,4048
+mock_vws/_query_validators/content_length_validators.py,sha256=WQ3ORFGu7zZ3w0ugumcKEP9Vz501pBhAPioRUFPUYpI,2752
+mock_vws/_query_validators/content_type_validators.py,sha256=V1HgxvxzFAW6ZYXQECkVZmbZjub3Qykzj1vBRkjOXio,2051
+mock_vws/_query_validators/date_validators.py,sha256=vjfwCjPC-DR7gRb3c8a-u9lc19AagPu6eyz31qVoKwc,3090
+mock_vws/_query_validators/exceptions.py,sha256=pXcL8NdUJrpcjnx-rSyefhq2aQN3DuQD306TBwp5A-o,23282
+mock_vws/_query_validators/fields_validators.py,sha256=vpo8FLKu5bF6t4mOGkiBJKuF_Rtg53uBq_A9fql6aCc,1357
+mock_vws/_query_validators/image_validators.py,sha256=1vTjFJSjfIkBb3fwpH9AYTI5pJdsRpv1M31UuQSezKo,5622
+mock_vws/_query_validators/include_target_data_validators.py,sha256=2F3i0stIz3RXyEvjbZqtoo4oUjllIIiRiWNR0F20lFM,1605
+mock_vws/_query_validators/num_results_validators.py,sha256=gJkc5ymF9uzcxJrW2ro45Y2dDIqqbb35Sf5BAPVQsnk,2156
+mock_vws/_query_validators/project_state_validators.py,sha256=5DBoWkt_Ii5f4JeU6TyWa6xpCPcIH9eKYHrEXohMH3c,1379
+mock_vws/_requests_mock_server/__init__.py,sha256=qoGQlH925pqG7yVXA6nUItfKCDUPM1fiuSMrvOYtkJk,65
+mock_vws/_requests_mock_server/decorators.py,sha256=8-AP9IwpUdeJ21Hw1P5vI2Cbh2AOvrr4LciCqOWrDjU,9986
+mock_vws/_requests_mock_server/mock_web_query_api.py,sha256=thdu6J6FGqNmmet_BJgtgjsGW4nh8coCsTbjqypYiU8,4187
+mock_vws/_requests_mock_server/mock_web_services_api.py,sha256=8ewe66qgxpfD8NAc7R9m5qj0nXQsbhSWPeCwLMgWxh0,33472
+mock_vws/_respx_mock_server/__init__.py,sha256=ol0PVGVPEzNrBQTnPm6cOPxrfWIHZHMqSfQDHAKrh8I,72
+mock_vws/_respx_mock_server/decorators.py,sha256=9mkC7Z42l53zGP3BWiSPoAkSxA1wUpp_hTZ1LZFkjHU,5530
+mock_vws/_services_validators/__init__.py,sha256=KWJhJVqH0c71hCNKYrneP-SC2NMT2FK-gas3ViYozVo,5948
+mock_vws/_services_validators/active_flag_validators.py,sha256=9lCCLtZOaG2-wYYugB1kI0DF--g0uo49B2OVl_bRkmQ,1049
+mock_vws/_services_validators/auth_validators.py,sha256=5hpTn_WtsUWLKNbSK_lpK5AdkeAhD-JITJDL0PquLSo,3472
+mock_vws/_services_validators/content_length_validators.py,sha256=Ordpz-4SIpVXL0FjlehbaEs7KmaH52ak8G1RO2cDbo8,3088
+mock_vws/_services_validators/content_type_validators.py,sha256=RXsxp9baqp2v845UJd2CR9mi0pcqL_fwUHpL8n9jyks,1150
+mock_vws/_services_validators/date_validators.py,sha256=jPTmlCXfo8-5VzT0Wlmltmpnxgo4VqfxF9Mx0RINuYs,2257
+mock_vws/_services_validators/exceptions.py,sha256=pIv7lXXNTdiETCAlTmpOlBifN46Gvffif7YYxzLWOh8,27661
+mock_vws/_services_validators/image_validators.py,sha256=GQU_mVrDkBJlvJlzH4fIB2IH2Gslo9dGhUs_-PBccfg,5582
+mock_vws/_services_validators/json_validators.py,sha256=EkyG8OGXtsnnilNfG2Fc7la2qkYrky49xUtatZFgjXE,1991
+mock_vws/_services_validators/key_validators.py,sha256=jpaAWkWRhcWTY1Q0fH1BXuu2spJHnt8w8Bt0nQ9V_iw,4556
+mock_vws/_services_validators/metadata_validators.py,sha256=zYchyB4NcM05Y0e-Jhoju4OHzZsfNUydAOMHWof_6GQ,2906
+mock_vws/_services_validators/name_validators.py,sha256=EqFyBGPKfelwJNeVKF_HeyFFf6acL4NeKJvgj6Dj8Ks,6318
+mock_vws/_services_validators/project_state_validators.py,sha256=pWLYdM2oBLBUzwWMKSFrdMld-YocVvh912v0kHw2n9I,2093
+mock_vws/_services_validators/request_quota_validators.py,sha256=Iqo15S5Ndg6JCZX4O04To96EkfO6xLwqMLFJO9srY90,1226
+mock_vws/_services_validators/target_quota_validators.py,sha256=71V_NkMkutLZ6aL_3sHQ0SO4EsjCYPDxwn-PxEngSio,1113
+mock_vws/_services_validators/target_validators.py,sha256=O5HTaUDozuD49CqkWNHU0AbCWMDJQYnRIjqgV45QjHA,1973
+mock_vws/_services_validators/width_validators.py,sha256=hnDresV9LYar5fKhkV3cTIyVWc7MGRfY2qjKqxIG5CY,956
+vws_python_mock-2026.8.4.dist-info/licenses/LICENSE,sha256=N3qm7laipxyuXkWpYllj89AObvPbtWgoABmaKfhQYL4,1069
+vws_python_mock-2026.8.4.dist-info/METADATA,sha256=3fypgOJhgiarswfjHj8n3m85eOH6hrTZAsXURR7y8Vg,6979
+vws_python_mock-2026.8.4.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+vws_python_mock-2026.8.4.dist-info/top_level.txt,sha256=ZM_u8TQO53nPg6timoI2AgUE0BhxIZrXkpT4s46DGlo,9
+vws_python_mock-2026.8.4.dist-info/RECORD,,

vws_python_mock-2026.8.4.dist-info/WHEEL

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

vws_python_mock-2026.8.4.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_mock-2026.8.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+mock_vws