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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws-cli-2024.1.30.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.30.1.tar.gz
Algorithm Hash digest
SHA256 8b2432246e8fbf005b3d5ba8e9d2c58bfd9a488054bcfe3b86677baef2559534
MD5 895f14dfe2fbc3a97bdbe41020846b03
BLAKE2b-256 56e25d8d432368810b840d3433a4b0ada4e4a429f4817fbe4a581833824bf175

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vws_cli-2024.1.30.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fef4d3b973fb2a405f3f90f9621b3ebfe356e54e0be1bd1236b59ffd287b4633
MD5 260b0221824c4315b6089afa04d6fdc9
BLAKE2b-256 5f975876dbcda526caf6947baaf5823cd0555f42d4fe76868e46bd15dda536d6

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