Skip to main content

Interact with the Vuforia Web Services (VWS) API.

Project description

Build Status codecov PyPI Documentation Status

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.12+. Get in touch with adamdangoor@gmail.com if you would like to use this with another language.

Getting Started

import pathlib

from vws import VWS, CloudRecoService

server_access_key = '[server-access-key]'
server_secret_key = '[server-secret-key]'
client_access_key = '[client-access-key]'
client_secret_key = '[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'

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)
    matching_targets = cloud_reco_client.query(image=my_image_file)

assert matching_targets[0].target_id == target_id

Full Documentation

See the full documentation.

Project details


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-2024.9.2.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

vws_python-2024.9.2-py2.py3-none-any.whl (15.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: vws_python-2024.9.2.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for vws_python-2024.9.2.tar.gz
Algorithm Hash digest
SHA256 7c8d62b9df0a9fca0c6383143506c79fb2f3bedd79f092c7d1a22936deaf5e2d
MD5 d58822be53b37df050b27e48280f8b54
BLAKE2b-256 cd2b21a1fc8533834920434347315f016ff6d070aea487962b23ba3dfa1f9ae2

See more details on using hashes here.

File details

Details for the file vws_python-2024.9.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for vws_python-2024.9.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a736e33e4dc981e79cc2278379925559f5ee6334788c161bde282c651310122d
MD5 1219ec17f4169a3ae5426f6ef73d6dde
BLAKE2b-256 a941239c5d1c0ffb9c3a38071456640a36ceacdabac5bc7cde0320a841993bac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page