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

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

Uploaded Source

Built Distribution

vws_cli-2023.2.21-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file vws_cli-2023.2.21.tar.gz.

File metadata

  • Download URL: vws_cli-2023.2.21.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for vws_cli-2023.2.21.tar.gz
Algorithm Hash digest
SHA256 89c8abd3215ab3acf475d6a65c49693de598cde34bfc4423133950847b9de541
MD5 9a06c6098e3b09177f84f532de9c4c6c
BLAKE2b-256 2e64c097bab08bf7e2828a2dd229ca35271381adc9d7c2e42023dfe070c8e36e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vws_cli-2023.2.21-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for vws_cli-2023.2.21-py3-none-any.whl
Algorithm Hash digest
SHA256 b75abdb335abf4ffb116a0d1335b0fafe72766310aabdfd9ba55f8e897e679cd
MD5 3c3895f22e0d21f0de7ddc71b6a6203a
BLAKE2b-256 b300c992673e033e7f160a6e11843ef5463a7e32b3ba89a2ece4c5d50808afd0

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