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

Uploaded Source

Built Distribution

vws_python-2024.9.3-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.3.tar.gz.

File metadata

  • Download URL: vws_python-2024.9.3.tar.gz
  • Upload date:
  • Size: 33.6 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.3.tar.gz
Algorithm Hash digest
SHA256 9a334fc35875a46995bf992f19f2cdc0c67aef0d4e9aa6244bf5bce22887bfbb
MD5 ec8c563a6cb1de68af50ba3b7e0724eb
BLAKE2b-256 c4d2c532ce5a8fcc24366b66dbe2945530ba6e543cc8cb7457aefb3959a6440e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2024.9.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ff1cc6a55ef123b8bdb07f169682bd37315023183253933109147aa24cd0eda5
MD5 e820536210615373191f5aaced42369c
BLAKE2b-256 9ebf509e990c066cc4e8c007b7551e55016241bdd1544b47654a92b8ef7cf1a1

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