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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws_cli-2023.2.21.2.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.2.tar.gz
Algorithm Hash digest
SHA256 f7f2bbd0124260545ea66b7123afe84bb094ae398cd9e868ac2eff5abfa464d7
MD5 f8b0e485c0887d10ac749232492ca7e0
BLAKE2b-256 d63f5b6e7dfd27b5b7d61348718cb371c05341f89e1c0f17f667ced89d898718

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2023.2.21.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9517b8ef9f7ac749c11c0233edb3a8027454cb72b850671768a321bd7d6190e4
MD5 319663d829215db46eb8126fff49dcfa
BLAKE2b-256 aa9c68e1c08308b2c28c6fdb8c8e0f0529879317d106a903ac8e763baa616e29

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