Metadata-Version: 2.1
Name: VWS-CLI
Version: 2019.12.27.0
Summary: 'A CLI for the Vuforia Web Services (VWS) API.'
Home-page: https://github.com/adamtheturtle/vws-cli
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT License
Keywords: vuforia vws cli
Platform: UNKNOWN
Classifier: Operating System :: POSIX
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Requires-Dist: PyYAML (==5.2)
Requires-Dist: VWS-Python (==2019.12.27.3)
Requires-Dist: click-pathlib (==2019.6.13.1)
Requires-Dist: click (==7.0.0)
Requires-Dist: requests (==2.22.0)
Requires-Dist: wrapt (==1.11.2)
Provides-Extra: dev
Requires-Dist: VWS-Python-Mock (==2019.12.27.0) ; extra == 'dev'
Requires-Dist: VWS-Test-Fixtures (==2019.12.13.1) ; extra == 'dev'
Requires-Dist: check-manifest (==0.40) ; extra == 'dev'
Requires-Dist: codecov (==2.0.15) ; extra == 'dev'
Requires-Dist: doc8 (==0.8.0) ; extra == 'dev'
Requires-Dist: docker (==4.1.0) ; extra == 'dev'
Requires-Dist: dulwich (==0.19.14) ; extra == 'dev'
Requires-Dist: flake8-commas (==2.0.0) ; extra == 'dev'
Requires-Dist: flake8-quotes (==2.1.1) ; extra == 'dev'
Requires-Dist: flake8 (==3.7.9) ; extra == 'dev'
Requires-Dist: freezegun (==0.3.12) ; extra == 'dev'
Requires-Dist: homebrew-pypi-poet (==0.10.0) ; extra == 'dev'
Requires-Dist: isort (==4.3.21) ; extra == 'dev'
Requires-Dist: mypy (==0.761) ; extra == 'dev'
Requires-Dist: pip-check-reqs (==2.0.3) ; extra == 'dev'
Requires-Dist: pydocstyle (==5.0.1) ; extra == 'dev'
Requires-Dist: pygithub (==1.44.1) ; extra == 'dev'
Requires-Dist: pylint (==2.4.4) ; extra == 'dev'
Requires-Dist: pyroma (==2.6) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.8.1) ; extra == 'dev'
Requires-Dist: pytest (==5.3.2) ; extra == 'dev'
Requires-Dist: sphinx-click (==2.3.1) ; extra == 'dev'
Requires-Dist: sphinx (==2.3.1) ; extra == 'dev'
Requires-Dist: sphinxcontrib.spelling (==4.3.0) ; extra == 'dev'
Requires-Dist: twine (==3.1.1) ; extra == 'dev'
Requires-Dist: vulture (==1.2) ; extra == 'dev'
Requires-Dist: yapf (==0.29.0) ; extra == 'dev'
Provides-Extra: packaging

|Build Status| |codecov| |Updates| |PyPI| |Documentation Status|

vws-cli
=======

A CLI for Vuforia.

Installation
------------

Installing with `pip`
^^^^^^^^^^^^^^^^^^^^^

Requires Python 3.8+.

.. code:: sh

   pip install VWS-CLI

Usage example
-------------

.. code:: sh

   $ 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 <https://vws-cli.readthedocs.io/en/latest>`__ for information on all available commands.


.. |Build Status| image:: https://travis-ci.com/adamtheturtle/vws-cli.svg?branch=master
   :target: https://travis-ci.com/adamtheturtle/vws-cli
.. |codecov| image:: https://codecov.io/gh/adamtheturtle/vws-cli/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/adamtheturtle/vws-cli
.. |Updates| image:: https://pyup.io/repos/github/adamtheturtle/vws-cli/shield.svg
   :target: https://pyup.io/repos/github/adamtheturtle/vws-cli/
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-cli/badge/?version=latest
   :target: https://vws-cli.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. |PyPI| image:: https://badge.fury.io/py/VWS-CLI.svg
   :target: https://badge.fury.io/py/VWS-CLI


