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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws_cli-2023.2.21.6.tar.gz
  • Upload date:
  • Size: 36.0 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.6.tar.gz
Algorithm Hash digest
SHA256 85b7d207e848d0cf51fef63f6036f2a4c4cd871896a2161b25c345e9c6f7f18f
MD5 b7bc14a71b73cbd545c86228944df41d
BLAKE2b-256 5b25561b82b952e73643a202ca2f76ad8938790d5538e17d0ac05477ea62b79a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2023.2.21.6-py3-none-any.whl
Algorithm Hash digest
SHA256 eec25ed6158fa06a4d548ab9c7d2b3da661178b608feeb0cbc295c6a67638caa
MD5 15edcaf5a149d21cb13e41aeef2c6e2c
BLAKE2b-256 153fd1a440ba629dd6429118b2a1913db65d35ba0de67a99af1693bfba0e6432

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