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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws-cli-2024.2.21.2.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.2.tar.gz
Algorithm Hash digest
SHA256 20787ac55f14b96f8c7781c79a2cb5f803bd15b3b00fb7afd3e5aea2c6ecf07b
MD5 6ff9ede5352c8cb7c297e96d835a23b8
BLAKE2b-256 1af24944443b89e212204cca79ac06a09d015e7c6e78cbb0fca399b6054a39b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.2.21.2-py3-none-any.whl
Algorithm Hash digest
SHA256 39ccfaab3200a23c7898cf93528042ed8bf4bd47e9db12d9c20910275ceb9821
MD5 0495abf179acf5498de7f5428a6061b6
BLAKE2b-256 489933198c2b9d86740a3e8e5ed7f7065276b75a1eef302664707e8a433a6e4a

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