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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws_cli-2023.2.21.1.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.1.tar.gz
Algorithm Hash digest
SHA256 228a31bb5f4448f1a42a868681d86cc954580371c8a772ea7f332ac98b637473
MD5 5aaab11cc7b1dd9e718b635b4fcf3673
BLAKE2b-256 4a87b9d704e049cd8a436d6f82adf3a2214addd409df9377ebe84a41edf29502

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2023.2.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80999496cdcfd325629fcdbe66efa6154683d956e5c528d736d67ad5599e5c75
MD5 c82f08ee40502cc6e63abd8b619f9915
BLAKE2b-256 82da8b99e4f31042c7b59236271e1e1adf09339e9f2d41c03c6ccd1c96bc3ab8

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