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.9+. Get in touch with adamdangoor@gmail.com if you would like to use this with another language.

Getting Started

import io

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'

with open('/path/to/image.png', 'rb') as my_image_file:
   my_image = io.BytesIO(my_image_file.read())

target_id = vws_client.add_target(
    name=name,
    width=1,
    image=my_image,
    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)

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

Uploaded Source

Built Distribution

VWS_Python-2021.3.28.0-py2.py3-none-any.whl (14.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file VWS Python-2021.3.28.0.tar.gz.

File metadata

  • Download URL: VWS Python-2021.3.28.0.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for VWS Python-2021.3.28.0.tar.gz
Algorithm Hash digest
SHA256 e0c07f7fa5d9ebbb15ba80668e7b572836296945edf2f46e9f4423cb5ff16ebd
MD5 6b3171df8d48d23627e3172bafe319d4
BLAKE2b-256 1efbf6480e94b9eea9cd6c3a1f81e68c492b18824cc313216ba0eff571be461c

See more details on using hashes here.

File details

Details for the file VWS_Python-2021.3.28.0-py2.py3-none-any.whl.

File metadata

  • Download URL: VWS_Python-2021.3.28.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for VWS_Python-2021.3.28.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 be756b9cd1ff46de5cb50ebd04e4f9243f42a45e44f1fc39da2dba690b7e6e73
MD5 423f7d0d76830e5c8a82a0d1d0e625fc
BLAKE2b-256 6b3829edad65015dedf71b9953070891e82e1db39553180ed54689d3ced982d8

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