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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vws-cli-2024.1.30.tar.gz
Algorithm Hash digest
SHA256 ded1bb8d1924f53fe78b1b124f21a7d68034cfab0f18fc8aff27504613e60c26
MD5 87f24ee7628ad8a989edc1bbbec65224
BLAKE2b-256 7655406972162c7a95f9ffcb05f3f16447f12fb249b5816666a29483f77ffe5b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for vws_cli-2024.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 b606abedfac7eeff7e861c5a07eeb660bfd2a900f02d36a1d28d48c2295d508d
MD5 f798a478182f09cdf768b59a60c4aae2
BLAKE2b-256 f16cfb246a99f9bceefbe55783d6d342b87f7b7322f512e823085c078d43f0f2

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