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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vws-cli-2024.1.30.6.tar.gz
Algorithm Hash digest
SHA256 f52d210cb1a7c75bbeed6b921c71b35153551648a4cafec0fd0a47bc8cd50168
MD5 e89a98d07a33d21f0257bd674fdce25f
BLAKE2b-256 02ae254a3fed1295211f354a4a8f628ba6739f2d182c72591270ef31143befa4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.1.30.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4ccd7f098dd7736c1dbe57235b1de0d7eaa82c4056cefd9f093659edcffbad7d
MD5 6c8f385a103eb95256026d9f8066de37
BLAKE2b-256 4cbb7375ba19100b8be94eff1efdb2dfd4511daddc03c9d5c8429d1b8145508c

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