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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: vws-python-2024.2.19.tar.gz
  • Upload date:
  • Size: 32.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for vws-python-2024.2.19.tar.gz
Algorithm Hash digest
SHA256 cc765b30de513dc84c6ff030ee8cc3cc8d50bc5f8f9e5b7a0780eb5b20a986a3
MD5 99db8050d4e9412e590f714607cb3ad4
BLAKE2b-256 d2cd9e0fef8be88a6e6f79c402fad08c4b42797652ab451a4ed31e0d46ee43b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2024.2.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a8ac04f71682a3e0493b148aaa3cf3b58560e89322ce71abaaefb6a0e583c047
MD5 c048033330667fa0d9930ed8fcc1d7e2
BLAKE2b-256 9efe1492395ecd4b069f3853da54f7f7878561ff511ef6e80cd9e88589ec70f2

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