Metadata-Version: 2.1
Name: VWS-Python
Version: 2019.11.7.2
Summary: Interact with the Vuforia Web Services (VWS) API.
Home-page: http://vws-python.readthedocs.io
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT
Keywords: vuforia fake client
Platform: UNKNOWN
Classifier: Operating System :: POSIX
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 3 - Alpha
Requires-Dist: requests (==2.22.0)
Requires-Dist: timeout-decorator (==0.4.1)
Requires-Dist: urllib3 (==1.25.6)
Provides-Extra: dev
Requires-Dist: autoflake (==1.3.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: dodgy (==0.1.9) ; extra == 'dev'
Requires-Dist: dulwich (==0.19.13) ; 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: isort (==4.3.21) ; extra == 'dev'
Requires-Dist: mypy (==0.740) ; extra == 'dev'
Requires-Dist: pip-check-reqs (==2.0.3) ; extra == 'dev'
Requires-Dist: pydocstyle (==4.0.1) ; extra == 'dev'
Requires-Dist: pyenchant (==2.0.0) ; extra == 'dev'
Requires-Dist: pygithub (==1.44.1) ; extra == 'dev'
Requires-Dist: Pygments (==2.4.2) ; extra == 'dev'
Requires-Dist: pylint (==2.4.3) ; extra == 'dev'
Requires-Dist: pyroma (==2.6) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.8.1) ; extra == 'dev'
Requires-Dist: pytest (==5.2.2) ; extra == 'dev'
Requires-Dist: PyYAML (==5.1.2) ; extra == 'dev'
Requires-Dist: Sphinx (==2.2.1) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (==1.10.2) ; extra == 'dev'
Requires-Dist: sphinxcontrib-spelling (==4.3.0) ; extra == 'dev'
Requires-Dist: twine (==2.0.0) ; extra == 'dev'
Requires-Dist: versioneer (==0.18) ; extra == 'dev'
Requires-Dist: vulture (==1.1) ; extra == 'dev'
Requires-Dist: VWS-Python-Mock (==2019.9.28.0) ; extra == 'dev'
Requires-Dist: yapf (==0.28.0) ; extra == 'dev'

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

vws-python
==========

Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.

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

.. code:: sh

   pip install vws-python

This is tested on Python 3.7+.
Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.

Getting Started
---------------

.. code:: python

   import io

   from vws import VWS, CloudRecoService

   vws_client = VWS(server_access_key='...', server_secret_key='...')
   cloud_reco_client = CloudRecoService(client_access_key='...', client_secret_key='...')
   name = 'my_image_name'

   with open('/path/to/image.png', 'rb') as my_image_file:
      my_image = io.BytesIO(my_image_file.read())

   target_id = vws_client.add_target(
       name=name,
       width=1,
       image=my_image,
   )
   vws_client.wait_for_target_processed(target_id=target_id)
   matching_targets = cloud_reco_client.query(image=my_image)

   assert matching_targets[0]['target_id'] == target_id


Full Documentation
------------------

See the `full documentation <https://vws-python.readthedocs.io/en/latest>`__.

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


