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.11+. 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.3.25.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

vws_python-2023.3.25-py2.py3-none-any.whl (15.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for vws-python-2023.3.25.tar.gz
Algorithm Hash digest
SHA256 f8ec0acfeee8ad1158038cf5b2be214783ab88080540ec018266a8bd525823e3
MD5 0d6c8531ca6f4fa5283f13b565aecc90
BLAKE2b-256 644d6b2095ca3fd560eeb484a1ceac6a7170c3e656aa881d2db34e0ab49fe8f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2023.3.25-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 17b9c8f5e8b080ece29ce6a17e9c8c389f5d221770c17a0bec21d43e5e350cef
MD5 4591695d9c52bdc48d2380705194f1c6
BLAKE2b-256 7c555d90e7ebbc311d78b8662827b4caf88b37cdf9d983cdb9838284fe2bc7da

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