vws-python
Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
Installation
pip install vws-pythonThis is tested on Python 3.14+. Get in touch with adamdangoor@gmail.com if you would like to use this with another language.
Getting Started
"""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_idFull Documentation
See the full documentation.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vws_python-2026.8.14.tar.gz.
File metadata
- Download URL: vws_python-2026.8.14.tar.gz
- Upload date:
- Size: 80.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bfcfc6196cbecb0e0c8f11fd7c358d53a8453a102078e8482ac6cc4c885239ca
|
|
| MD5 |
361aa474d03a812df1b4c89ec1a98ef5
|
|
| BLAKE2b-256 |
3f50b65d70abb437082f723fc71f01003c0fa7a5ff4ee0aff990ec9878609a9a
|
Provenance
The following attestation bundles were made for vws_python-2026.8.14.tar.gz:
Publisher:
release.yml on VWS-Python/vws-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vws_python-2026.8.14.tar.gz -
Subject digest:
bfcfc6196cbecb0e0c8f11fd7c358d53a8453a102078e8482ac6cc4c885239ca - Sigstore transparency entry: 2466671174
- Sigstore integration time:
-
Permalink:
VWS-Python/vws-python@cf2f0498539090f53970380caa5291d4ad0b263b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/VWS-Python
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cf2f0498539090f53970380caa5291d4ad0b263b -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file vws_python-2026.8.14-py3-none-any.whl.
File metadata
- Download URL: vws_python-2026.8.14-py3-none-any.whl
- Upload date:
- Size: 47.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e80f9fb64f3190eef82bc7a1685fecb6670795a70169c2546088ccb68b135381
|
|
| MD5 |
6c0350e3abad8bee41de0c52783eea16
|
|
| BLAKE2b-256 |
d0b0f8b44fd494abaade88eb396c73c729546d1db1bb13792cd79eb363514f71
|
Provenance
The following attestation bundles were made for vws_python-2026.8.14-py3-none-any.whl:
Publisher:
release.yml on VWS-Python/vws-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vws_python-2026.8.14-py3-none-any.whl -
Subject digest:
e80f9fb64f3190eef82bc7a1685fecb6670795a70169c2546088ccb68b135381 - Sigstore transparency entry: 2466671189
- Sigstore integration time:
-
Permalink:
VWS-Python/vws-python@cf2f0498539090f53970380caa5291d4ad0b263b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/VWS-Python
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cf2f0498539090f53970380caa5291d4ad0b263b -
Trigger Event:
workflow_dispatch
-
Statement type:
