Metadata-Version: 2.1
Name: VWS-Test-Fixtures
Version: 2022.1.3
Summary: Authentication and authorization tools for interacting with the Vuforia Web Services (VWS) API.
Home-page: https://github.com/VWS-Python/vws-test-fixtures
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT License
Keywords: vuforia vws
Platform: UNKNOWN
Classifier: Operating System :: POSIX
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Pillow
Requires-Dist: pytest
Provides-Extra: dev
Requires-Dist: Sphinx-Substitution-Extensions (==2020.9.30.0) ; extra == 'dev'
Requires-Dist: autoflake (==1.4) ; extra == 'dev'
Requires-Dist: black (==21.12b0) ; extra == 'dev'
Requires-Dist: check-manifest (==0.47) ; extra == 'dev'
Requires-Dist: doc8 (==0.10.1) ; extra == 'dev'
Requires-Dist: flake8-commas (==2.1.0) ; extra == 'dev'
Requires-Dist: flake8-quotes (==3.3.1) ; extra == 'dev'
Requires-Dist: flake8 (==4.0.1) ; extra == 'dev'
Requires-Dist: freezegun (==1.1.0) ; extra == 'dev'
Requires-Dist: furo (==2021.11.23) ; extra == 'dev'
Requires-Dist: isort (==5.10.1) ; extra == 'dev'
Requires-Dist: mypy (==0.930) ; extra == 'dev'
Requires-Dist: pip-check-reqs (==2.3.2) ; extra == 'dev'
Requires-Dist: pydocstyle (==6.1.1) ; extra == 'dev'
Requires-Dist: pylint (==2.12.2) ; extra == 'dev'
Requires-Dist: pyroma (==3.2) ; extra == 'dev'
Requires-Dist: pytest-cov (==3.0.0) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (==1.12.0) ; extra == 'dev'
Requires-Dist: sphinx (==4.3.2) ; extra == 'dev'
Requires-Dist: sphinxcontrib.spelling (==7.3.2) ; extra == 'dev'
Requires-Dist: types-setuptools (==57.4.5) ; extra == 'dev'
Requires-Dist: vulture (==2.3) ; extra == 'dev'
Provides-Extra: packaging

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

VWS Test Fixtures
==================

``pytest`` fixtures for testing tools with the Vuforia Web Services (VWS) API.

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

.. code:: sh

   pip install vws-test-fixtures

This is tested on Python 3.10+.

Example usage
-------------

.. code:: python

   # A test to be run by pytest
   def test_example(high_quality_image: io.BytesIO) -> None:
       image_file_bytes = high_quality_image.getvalue()
       ...

``high_quality_image`` returns an image file which is expected to have a 'success' status when added to a target, and a high tracking rating.

``image_file_failed_state`` is expected to be accepted by the add and update target endpoints, but get a "failed" status.

``png_too_large`` is a PNG which has dimensions whcih are too large to be added to a Vuforia database.

... and more, see the `full documentation <https://vws-test-fixtures.readthedocs.io/en/latest>`__ for details of all fixtures provided.

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

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

.. |Build Status| image:: https://github.com/VWS-Python/vws-test-fixtures/workflows/CI/badge.svg
   :target: https://github.com/VWS-Python/vws-test-fixtures/actions
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-test-fixtures/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/VWS-Python/vws-test-fixtures
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-test-fixtures/badge/?version=latest
   :target: https://vws-test-fixtures.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. |PyPI| image:: https://badge.fury.io/py/VWS-Test-Fixtures.svg
   :target: https://badge.fury.io/py/VWS-Test-Fixtures


