Metadata-Version: 2.1
Name: VWS-Python-Mock
Version: 2020.9.25.0
Summary: A mock for the Vuforia Web Services (VWS) API.
Home-page: https://vws-python-mock.readthedocs.io
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT License
Keywords: vuforia mock fake client
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
Description-Content-Type: text/x-rst
Requires-Dist: Pillow
Requires-Dist: VWS-Auth-Tools
Requires-Dist: backports.zoneinfo
Requires-Dist: flask
Requires-Dist: requests-mock
Requires-Dist: requests
Requires-Dist: wrapt
Provides-Extra: dev
Requires-Dist: PyYAML (==5.3.1) ; extra == 'dev'
Requires-Dist: Sphinx-Substitution-Extensions (==2020.7.4.1) ; extra == 'dev'
Requires-Dist: Sphinx (==3.2.1) ; extra == 'dev'
Requires-Dist: VWS-Test-Fixtures (==2020.8.2.0) ; extra == 'dev'
Requires-Dist: attrs (==20.2.0) ; extra == 'dev'
Requires-Dist: autoflake (==1.4) ; extra == 'dev'
Requires-Dist: black (==20.8b1) ; extra == 'dev'
Requires-Dist: check-manifest (==0.43) ; extra == 'dev'
Requires-Dist: doc8 (==0.8.1) ; extra == 'dev'
Requires-Dist: dodgy (==0.2.1) ; extra == 'dev'
Requires-Dist: flake8-commas (==2.0.0) ; extra == 'dev'
Requires-Dist: flake8-quotes (==3.2.0) ; extra == 'dev'
Requires-Dist: flake8 (==3.8.3) ; extra == 'dev'
Requires-Dist: freezegun (==1.0.0) ; extra == 'dev'
Requires-Dist: isort (==5.5.3) ; extra == 'dev'
Requires-Dist: keyring (==21.4.0) ; extra == 'dev'
Requires-Dist: mypy (==0.782) ; extra == 'dev'
Requires-Dist: pip-check-reqs (==2.1.1) ; extra == 'dev'
Requires-Dist: pydocstyle (==5.1.1) ; extra == 'dev'
Requires-Dist: pyenchant (==3.1.1) ; extra == 'dev'
Requires-Dist: pygithub (==1.53) ; extra == 'dev'
Requires-Dist: pylint (==2.6.0) ; extra == 'dev'
Requires-Dist: pyroma (==2.6) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.10.1) ; extra == 'dev'
Requires-Dist: pytest-envfiles (==0.1.0) ; extra == 'dev'
Requires-Dist: pytest (==6.0.2) ; extra == 'dev'
Requires-Dist: requests-mock-flask (==2020.9.18.0) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (==1.11.0) ; extra == 'dev'
Requires-Dist: sphinx-paramlinks (==0.4.2) ; extra == 'dev'
Requires-Dist: sphinxcontrib-spelling (==5.4.0) ; extra == 'dev'
Requires-Dist: timeout-decorator (==0.4.1) ; extra == 'dev'
Requires-Dist: twine (==3.2.0) ; extra == 'dev'
Requires-Dist: vulture (==2.1) ; extra == 'dev'
Requires-Dist: vws-python (==2020.9.8.0) ; extra == 'dev'

|Build Status| |codecov| |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.8.5+.
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() as mock:
        database = VuforiaDatabase()
        mock.add_database(database=database)
        # This will use the Vuforia mock.
        requests.get('https://vws.vuforia.com/summary')

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://github.com/VWS-Python/vws-python-mock/workflows/CI/badge.svg
   :target: https://github.com/VWS-Python/vws-python-mock/actions
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python-mock/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/VWS-Python/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


