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.11+.

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

Uploaded Source

Built Distribution

vws_cli-2023.2.21.4-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file vws_cli-2023.2.21.4.tar.gz.

File metadata

  • Download URL: vws_cli-2023.2.21.4.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for vws_cli-2023.2.21.4.tar.gz
Algorithm Hash digest
SHA256 76b95ba30dc1a3a3395377de0abe133e15759f6befe6fe7f96d46560fbf30933
MD5 5c1b1bb97e9c2c4e61d8196ac2432853
BLAKE2b-256 4e545cb92df7f69c63717bf55aac0c0554b839394f743b0a1610ed8292e3592b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2023.2.21.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bb4affb88f2cb5d8881f8768e9a3af240c3ed5a090b850829003b5163dff235f
MD5 67dfdbeb0bd5efbaa8ab33b60329819d
BLAKE2b-256 af902802779c5ebe444d759d876c5fae307fb41e33e6ca3fe95d871b2b8c30f1

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