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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws_cli-2023.2.21.3.tar.gz
  • Upload date:
  • Size: 36.1 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.3.tar.gz
Algorithm Hash digest
SHA256 44bac97024e1eb820900bdcd46c55b614f382af506f69911806bc8ee1cd189b5
MD5 42e8377570553d9587ead484a3844e04
BLAKE2b-256 0d231ad2362b2c993baed816a547ba62633b04e8f154ba3c541b3b15d75a4dbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2023.2.21.3-py3-none-any.whl
Algorithm Hash digest
SHA256 56453f2c735400ad8451787e5ef0407ac70e6d84955b999ebab168f2c0b2f13a
MD5 9be4b4823be0043259e495bb2358947f
BLAKE2b-256 3a93ef2bc317dc9fb3f17591feb13f94cd8e6514501cfd229028a1855001d01c

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