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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vws-cli-2024.1.31.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vws-cli-2024.1.31.tar.gz
Algorithm Hash digest
SHA256 9fab396a7904f61519b3bddb5d2268200a962a2237582c522e506ea0962c3e2b
MD5 b186b4c487d696f89133876b30a357e0
BLAKE2b-256 1a0e3966fe6821768818ee1aa3b523d5b77987066a9c9121362e3432a52a426c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vws_cli-2024.1.31-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vws_cli-2024.1.31-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6ced1d3b064aa818a60a802ba7d5ab77b4955ba99a4657a6b6c5d1bb9ca7d5
MD5 df61d7936ff9ada124672df445d273d9
BLAKE2b-256 bfba785bff2b0b994ca21f1d53bb9d37fa2d801f47ae75b1b649f4ebd9eb1bfb

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