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.9+.

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

Uploaded Source

Built Distribution

VWS_CLI-2021.12.13.15-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file VWS CLI-2021.12.13.15.tar.gz.

File metadata

  • Download URL: VWS CLI-2021.12.13.15.tar.gz
  • Upload date:
  • Size: 37.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for VWS CLI-2021.12.13.15.tar.gz
Algorithm Hash digest
SHA256 de4fca6e54d79d46b7097947e6955fc8831f958867643432ab8c0823c5b48c3f
MD5 9ff7ee941afd26a67f84ea4809532496
BLAKE2b-256 cac1cc71eb667d43c08b52b971d901fbb34c611b5f7ecb5ed5864d84421091d4

See more details on using hashes here.

File details

Details for the file VWS_CLI-2021.12.13.15-py3-none-any.whl.

File metadata

  • Download URL: VWS_CLI-2021.12.13.15-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for VWS_CLI-2021.12.13.15-py3-none-any.whl
Algorithm Hash digest
SHA256 4c072cc57234465a1df33d054f484258f2adfb91e2c1c02b440eb74fe21f970a
MD5 0810a649009884878a40164e74e6a00d
BLAKE2b-256 9d32fa429fae6ed1338a3b3ad2e9adfd664ae132cfe9ac9d694118c9b6a70256

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