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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws-cli-2024.1.29.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.29.tar.gz
Algorithm Hash digest
SHA256 9e7441cc40e881a936c35209e77ab7d7e0adb52d2e95252f0ab4716058ef6175
MD5 11f4973f63cccf2168cafda8f3a4273a
BLAKE2b-256 57f264e670ce28a4e2272a7e0bb593fe4a99c32359b33bddb0ceb927c86b2553

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vws_cli-2024.1.29-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.29-py3-none-any.whl
Algorithm Hash digest
SHA256 df0297ee5f7396874cde73ebf4d33b7add6ea389e159afe28d4c4b2b33747b62
MD5 518ee59b942ddd05a7f8ffdd07867a0e
BLAKE2b-256 bf9719251ebeb3597cae388870778dc6e7d1972cbb66a9e3aafbd57191ac2dd2

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