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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: VWS CLI-2021.12.13.9.tar.gz
  • Upload date:
  • Size: 38.0 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.9.tar.gz
Algorithm Hash digest
SHA256 4899253058cafc304917a5bf5222acf8af35da527d722c7e03865c672a892618
MD5 2679389a0b5f7217bc119dfc74f6e6b5
BLAKE2b-256 2fdd072af5eb65976986ddd56a04c6fcb4282c2ce0fc2a6e2024d2fd3c73354f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: VWS_CLI-2021.12.13.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4c51745f2b960f39180d07450bea961752ed7696879276c70fd2968467734637
MD5 8b2c0a8b7db3bbfd8f4f583e419beb88
BLAKE2b-256 d474a041ca0bc0f5d6ecfbe950e9e1490261bef863a9b16e7427a0f2893dcacd

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