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

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

Uploaded Source

Built Distribution

vws_cli-2024.1.31.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file vws-cli-2024.1.31.1.tar.gz.

File metadata

  • Download URL: vws-cli-2024.1.31.1.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vws-cli-2024.1.31.1.tar.gz
Algorithm Hash digest
SHA256 5915cd8e6fd83446e797a77f6a33f24a8a10b62bebc11c14c829ca49de54cc55
MD5 0f065d57af7627f7966ef0ada87a0ad9
BLAKE2b-256 9f91ab8b498ba81f80e8c708877ede356c05da38b067b5aeb882d93b2e6b4a3d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.1.31.1-py3-none-any.whl
Algorithm Hash digest
SHA256 61b58404258bd17ffd211e9defb22cddf161919933f85ca14891a1595de5f7da
MD5 7e3a6ed1684c9aee3b9d316007ea2312
BLAKE2b-256 e4a5422d4e1b23cd5e7b4f9f52c71bba9027b20b46f22a42071b2ec1fdde98de

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