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

Uploaded Source

Built Distribution

vws_python-2023.12.26-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vws-python-2023.12.26.tar.gz.

File metadata

  • Download URL: vws-python-2023.12.26.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vws-python-2023.12.26.tar.gz
Algorithm Hash digest
SHA256 df7314028b4ec973fbe2605d11d72c78b4fd7e36cedb5ff707f29fdf721fde4e
MD5 119464cff1baaf6a560c7020374a63dd
BLAKE2b-256 384011b70dab47c1634ec24a91564b0d6732e129e5b782da978ba3b5799e26b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2023.12.26-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 59b7815c30fba723139353ac950b53aac6a4c5938b685bc9ff1d659082f02622
MD5 9a047e04a2f817e5f5ce089326b1df22
BLAKE2b-256 89cb1dea5292301c3f62dc56518153f86f8e1a26e49deeb85611f39c5e504ffe

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