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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: VWS CLI-2021.10.8.0.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for VWS CLI-2021.10.8.0.tar.gz
Algorithm Hash digest
SHA256 b48fae9e177a5a9d4599423cae00ca305f09cc2ad0c3e38f46478b12bb1488a2
MD5 4fa4a177e11c1c890f8a2e1f8e27fc71
BLAKE2b-256 561668f1ce6326b30583bb46ad8f2a2df44e84586e53903d4539d21bd46ed292

See more details on using hashes here.

File details

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

File metadata

  • Download URL: VWS_CLI-2021.10.8.0-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for VWS_CLI-2021.10.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af5c1a7a5ac0c6fdb595a1a8cd5258de5201df8d75d943baadf0cfa4d134a275
MD5 f64ba2a3d34ad8e5331dab68197c22c5
BLAKE2b-256 377ff21c37c0da3dc7b3b00f137869d8645b9f39d88ad5b3cb31bf3d3f58372d

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