Metadata-Version: 2.1
Name: VWS-Python-Mock
Version: 2018.12.1.0
Summary: A mock for the Vuforia Web Services (VWS) API.
Home-page: http://vws-python-mock.readthedocs.io
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT
Keywords: vuforia mock fake client
Platform: UNKNOWN
Classifier: Operating System :: POSIX
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: pillow (==5.3.0)
Requires-Dist: pytz (==2018.7)
Requires-Dist: requests-mock (==1.5.2)
Requires-Dist: requests (==2.20.1)
Requires-Dist: wrapt (==1.10.11)
Provides-Extra: dev
Requires-Dist: PyYAML (==3.13) ; extra == 'dev'
Requires-Dist: Sphinx (==1.8.2) ; extra == 'dev'
Requires-Dist: attrs (==18.2.0) ; extra == 'dev'
Requires-Dist: autoflake (==1.2) ; extra == 'dev'
Requires-Dist: check-manifest (==0.37) ; 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.9) ; extra == 'dev'
Requires-Dist: flake8-commas (==2.0.0) ; extra == 'dev'
Requires-Dist: flake8-quotes (==1.0.0) ; extra == 'dev'
Requires-Dist: flake8 (==3.6.0) ; extra == 'dev'
Requires-Dist: freezegun (==0.3.11) ; extra == 'dev'
Requires-Dist: isort (==4.3.4) ; extra == 'dev'
Requires-Dist: keyring (==17.0.0) ; extra == 'dev'
Requires-Dist: mypy (==0.641) ; extra == 'dev'
Requires-Dist: pip-check-reqs (==2.0.3) ; extra == 'dev'
Requires-Dist: pydocstyle (==3.0.0) ; extra == 'dev'
Requires-Dist: pyenchant (==2.0.0) ; extra == 'dev'
Requires-Dist: pygithub (==1.43.3) ; extra == 'dev'
Requires-Dist: pylint (==2.2.2) ; extra == 'dev'
Requires-Dist: pyroma (==2.4) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.6.0) ; extra == 'dev'
Requires-Dist: pytest-envfiles (==0.1.0) ; extra == 'dev'
Requires-Dist: pytest (==4.0.1) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (==1.5.1) ; extra == 'dev'
Requires-Dist: sphinxcontrib-spelling (==4.2.0) ; extra == 'dev'
Requires-Dist: timeout-decorator (==0.4.0) ; extra == 'dev'
Requires-Dist: twine (==1.12.1) ; extra == 'dev'
Requires-Dist: vulture (==1.0) ; extra == 'dev'
Requires-Dist: yapf (==0.25.0) ; extra == 'dev'

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

VWS Python Mock
===============

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

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

.. code:: sh

    pip3 install vws-python-mock

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

Mocking Vuforia
---------------

Requests made to Vuforia can be mocked.
Using the mock redirects requests to Vuforia made with `requests <https://pypi.org/project/requests/>`_ to an in-memory implementation.

.. code:: python

    import requests
    from mock_vws import MockVWS, VuforiaDatabase

    with MockVWS(database=database) as mock:
        database = VuforiaDatabase()
        mock.add_database(database=database)
        # This will use the Vuforia mock.
        requests.get('https://vws.vuforia.com/summary')

However, by default, an exception will be raised if any requests to unmocked addresses are made.

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

See the `full documentation <https://vws-python-mock.readthedocs.io/en/latest>`__.
This includes details on how to use the mock, options, and details of the differences between the mock and the real Vuforia Web Services.


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


