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

Uploaded Source

Built Distribution

vws_python-2024.2.6-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.6.tar.gz.

File metadata

  • Download URL: vws-python-2024.2.6.tar.gz
  • Upload date:
  • Size: 32.4 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.6.tar.gz
Algorithm Hash digest
SHA256 0c1e8d3fc7594b58e1e17c62b2a54e41d9c37337ef7895c0b0052dda412aafe1
MD5 63292649a869c42ee0267f620cbbe008
BLAKE2b-256 a47f3f05ecb8c5a3012820378c2dcb5a0daef07d33f5ec4ed63f81dd8ff605ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_python-2024.2.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a498012ed8a854e22e14b016d699b667d0c8cb185916a4c7edb42e544361d0cb
MD5 fcd9f4ff7312e967a3e0c3a55212bcde
BLAKE2b-256 25a8566c9e4b08ddf16116798b25a864d87bb67b75240ad325bb04b468591a89

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