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

Uploaded Source

Built Distribution

vws_cli-2023.9.9-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vws_cli-2023.9.9.tar.gz
Algorithm Hash digest
SHA256 bce854e64e479ff174773ad96d91d06341b2efe3a8ba4bdb372cc257fb8af11a
MD5 0668205563b533ced1a3c6599274687b
BLAKE2b-256 1c0594cc8785218ff5d11a648255e4ebaa92edddd11b6aadd9a5f59cc0831221

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vws_cli-2023.9.9-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for vws_cli-2023.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0ea66f6dee244ea01d8ed7e72a401eb08fb84ab150013dd7cc75f2c5bcbdf276
MD5 2b06fc91ab8eb7a2536b3fb920c04836
BLAKE2b-256 ea9f5c52ec33b2c02d1b9b436f1f7e2e2ee413c91fc742c868a47357b42e0432

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