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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vws-cli-2024.2.21.1.tar.gz
Algorithm Hash digest
SHA256 2b0ed7c46ac12b44a7e92dc31acc03c0bc560477732e26d0fe719d238a844ea2
MD5 8c01abc736aada5f52b17bac0b9d7851
BLAKE2b-256 241ad7be1edebcc818a769c48a4314acb524a5220209c1ea7003c8f8ee337280

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.2.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 47f288885adb19d08ea48da3b1bc63e2dec775ce70b97a4152dc1d1672f9a59b
MD5 84ee3730e75e509a8a3deefcf571ebf3
BLAKE2b-256 caa9da1d0dbc2edeb7478ebc0445ec931f436855ec760106f8a2fd76ed556d0e

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