vws-python

Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.

Installation

pip install vws-python

This 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_id

Full Documentation

See the full documentation.

Development Status
- 5 - Production/Stable
Environment
- Web Environment
Operating System
- Microsoft :: Windows
- POSIX
Programming Language
- Python :: 3 :: Only
- Python :: 3.14

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vws_python-2026.8.26.tar.gz (81.5 kB view details)

Uploaded Aug 26, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

vws_python-2026.8.26-py3-none-any.whl (47.3 kB view details)

Uploaded Aug 26, 2026 Python 3

File details

Details for the file vws_python-2026.8.26.tar.gz.

File metadata

Download URL: vws_python-2026.8.26.tar.gz
Upload date: Aug 26, 2026
Size: 81.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vws_python-2026.8.26.tar.gz
Algorithm	Hash digest
SHA256	`a02898c776537992fd83b11eda0df8ccf7e7341d399ca8250b99eb53c4225635`
MD5	`6bffdf1ca186000ca171a169bc414291`
BLAKE2b-256	`0d6b89de512a99ab736c288d98181e6309419f51db5b5238209575c2612ac0e4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for vws_python-2026.8.26.tar.gz:

Publisher: release.yml on VWS-Python/vws-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: vws_python-2026.8.26.tar.gz
- Subject digest: a02898c776537992fd83b11eda0df8ccf7e7341d399ca8250b99eb53c4225635
- Sigstore transparency entry: 2600615670
- Sigstore integration time: Aug 26, 2026
Source repository:
- Permalink: VWS-Python/vws-python@294e5ae94e89ab833a5976e14be6010963888ca6
- Branch / Tag: refs/heads/main
- Owner: https://github.com/VWS-Python
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@294e5ae94e89ab833a5976e14be6010963888ca6
- Trigger Event: workflow_dispatch