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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws-cli-2024.1.29.1.tar.gz
  • Upload date:
  • Size: 36.2 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.1.tar.gz
Algorithm Hash digest
SHA256 f0716ca3512f49c29cea9fccfd0cc7df97c79656234854a5f0530b7e10b18934
MD5 a0a85adecbacb09e32bd15e857e4ccdb
BLAKE2b-256 9118671824ffd56b4b23147b6d53b8a76ef41f5ab551a46480a0dba5477b0613

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.1.29.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0bd517eb800ad4294612718da774d29dbff82cd17b9d36960bbd95854ee4535
MD5 f6454503c93d9c96843fd954f0298bad
BLAKE2b-256 2917213da00b0e7eea64cad94d336d834608f903900828937ff49c1135ab3c3b

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