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

Uploaded Source

Built Distribution

vws_python-2024.2.4-py2.py3-none-any.whl (15.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for vws-python-2024.2.4.tar.gz
Algorithm Hash digest
SHA256 19f56493f35c22198c937367b45907446183e97aa119242abd78dc918df309b2
MD5 c2d4c67d15246bed67f157c877f31c1b
BLAKE2b-256 36f8cbc7c853e01e527cfac0606180a787c73b0a73503841af29b3c63d6475fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2024.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 087a77a487bdb9d7ae798f6329323affce08a1b91be3f0f613760335189d17a6
MD5 50d389e67559cce07ac7318cb6ce562e
BLAKE2b-256 778e8f6b221866552ae290e00fcd48ce954ade84628acd64eba4dc71a4202a32

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