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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: VWS CLI-2021.12.15.3.tar.gz
  • Upload date:
  • Size: 34.7 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.15.3.tar.gz
Algorithm Hash digest
SHA256 9bf4107707a309578b117141ce66c24c55902492abd24c6beaed12a76da6d05f
MD5 85bf8acdf5e9af7fa9e0f17ef89c7627
BLAKE2b-256 7268a51d15e0173fb6d9338985fd55cb8ba058bbdfe64a6326fa41fad87a54f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: VWS_CLI-2021.12.15.3-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.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 01ed4e2a0f564edc9fd0a1973ccf899b14618490b8a2bf7dff7ec3c12ddbc240
MD5 80b9e0755b0dd01607b840074b2869fd
BLAKE2b-256 0b25c575674003c0a139057928e301c06e1cf1743e9e48f8c8afff8fdf4caad1

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