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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws_cli-2024.9.11.1.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for vws_cli-2024.9.11.1.tar.gz
Algorithm Hash digest
SHA256 5115b9b8c5ad9df3fd0e2e130a8a33974871e80c18686ea0a213af846f4289fc
MD5 567d78024dd911b033562fa968abc715
BLAKE2b-256 c3a7571254e8247d163748174a57a2244830d34f57d6f85468be7be6b266d8cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.9.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c500db8ad02fd7013a9577ac9c6e2ef172393395b1245dc86fc4080348f91b1b
MD5 5e3c474db97b60516e51a3285ba3ce93
BLAKE2b-256 12267cc22903e900967e3436ba6a4b8c6c594e8ca8e9730fbe1c96c42a953890

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