Skip to main content

A CLI for the Vuforia Web Services (VWS) API.

Project description

Build Status codecov PyPI Documentation Status

vws-cli

A CLI for Vuforia Web Services.

Installation

With pip

Requires Python 3.11+.

pip install VWS-CLI

With Homebrew (macOS, Linux, WSL)

Requires Homebrew.

brew tap VWS-Python/vws
brew install vws-cli

Pre-built Linux binaries

See the full documentation for details on how to install pre-built Linux binaries.

Usage example

$ vws add-target \
    --server-access-key $SERVER_ACCESS_KEY \
    --server-secret-key $SERVER_SECRET_KEY \
    --name my_image_name \
    --width 2 \
    --image ~/Documents/my_image.png \
    --application-metadata $(echo "my_metadata" | base64) \
    --active-flag true
03b99df0-78cf-4b01-b929-f1860d4f8ed1
$ vws --help
...
$ vuforia-cloud-reco my_image.jpg \
    --max-num-results 5 \
    --include-target-data none
- target_id: b60f60121d37418eb1de123c381b2af9
- target_id: e3a6e1a216ad4df3aaae1f6dd309c800
$

Full documentation

See the full documentation for information on:

  • All available commands.

  • Setting up autocompletion.

  • How to contribute to this project.

  • Release notes.

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_cli-2023.2.21.7.tar.gz (36.1 kB view details)

Uploaded Source

Built Distribution

vws_cli-2023.2.21.7-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file vws_cli-2023.2.21.7.tar.gz.

File metadata

  • Download URL: vws_cli-2023.2.21.7.tar.gz
  • Upload date:
  • Size: 36.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for vws_cli-2023.2.21.7.tar.gz
Algorithm Hash digest
SHA256 3b3774bf93e690f3be381006dae2a4b4f344e7218131a4fea26c647d07a039ec
MD5 6de1660fc1fe3d931dbe1a732cd93262
BLAKE2b-256 3b18c4aa96b518a30a33350358c763e18dfe3ff1659969f25d68e22fbc2101db

See more details on using hashes here.

File details

Details for the file vws_cli-2023.2.21.7-py3-none-any.whl.

File metadata

File hashes

Hashes for vws_cli-2023.2.21.7-py3-none-any.whl
Algorithm Hash digest
SHA256 349b9b614b58bb5ae1516e0ea90fad80f0b35fc0e1a47f8d31206326b8a4d9a8
MD5 2574d1ee8fe168010c9efed47ea7b588
BLAKE2b-256 2f6646121c8e4dc0c53852f4fe92bcc782d81755bab03f753e3b52bc5cb803e8

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