Merge pull request #1824 from VWS-Python/test-readme

Test code in README

Author: adamtheturtle

README.md

@@ -0,0 +1,104 @@
+[![Build
+Status](https://github.com/VWS-Python/vws-python/workflows/CI/badge.svg)](https://github.com/VWS-Python/vws-python/actions)
+[![codecov](https://codecov.io/gh/VWS-Python/vws-python/branch/master/graph/badge.svg)](https://codecov.io/gh/VWS-Python/vws-python)
+[![PyPI](https://badge.fury.io/py/VWS-Python.svg)](https://badge.fury.io/py/VWS-Python)
+[![Documentation Status](https://readthedocs.org/projects/vws-python/badge/?version=latest)](https://vws-python.readthedocs.io/en/latest/?badge=latest)
+
+# vws-python
+
+Python library for the Vuforia Web Services (VWS) API and the Vuforia
+Web Query API.
+
+## Installation
+
+```sh
+pip install vws-python
+```
+
+This is tested on Python 3.11+. Get in touch with
+`adamdangoor@gmail.com` if you would like to use this with another
+language.
+
+## Getting Started
+
+<!--
+```python
+import pathlib
+import shutil
+
+import vws_test_fixtures
+from mock_vws import MockVWS
+from mock_vws.database import VuforiaDatabase
+
+mock = MockVWS(real_http=False)
+database = VuforiaDatabase(
+    server_access_key='[server-access-key]',
+    server_secret_key='[server-secret-key]',
+    client_access_key='[client-access-key]',
+    client_secret_key='[client-secret-key]',
+)
+mock.add_database(database=database)
+mock.__enter__()
+
+# We rely on implementation details of the fixtures package.
+image = pathlib.Path(vws_test_fixtures.__path__[0]) / 'high_quality_image.jpg'
+assert image.exists(), image.resolve()
+new_image = pathlib.Path('high_quality_image.jpg')
+shutil.copy(image, new_image)
+```
+-->
+
+<!--pytest-codeblocks:cont-->
+
+```python
+import io
+import pathlib
+
+from vws import VWS, CloudRecoService
+
+server_access_key = '[server-access-key]'
+server_secret_key = '[server-secret-key]'
+client_access_key = '[client-access-key]'
+client_secret_key = '[client-secret-key]'
+
+vws_client = VWS(
+    server_access_key=server_access_key,
+    server_secret_key=server_secret_key,
+)
+cloud_reco_client = CloudRecoService(
+    client_access_key=client_access_key,
+    client_secret_key=client_secret_key,
+)
+name = 'my_image_name'
+
+image = pathlib.Path('high_quality_image.jpg')
+with image.open(mode='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,
+    active_flag=True,
+    application_metadata=None,
+)
+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
+```
+
+<!--pytest-codeblocks:cont-->
+
+<!--
+```python
+new_image = pathlib.Path('high_quality_image.jpg')
+new_image.unlink()
+mock.__exit__()
+```
+-->
+
+## Full Documentation
+
+See the [full
+documentation](https://vws-python.readthedocs.io/en/latest).

README.rst

@@ -61,3 +61,4 @@ spelling:
 .PHONY: doctest
 doctest:
 	$(MAKE) -C docs/ doctest SPHINXOPTS=$(SPHINXOPTS)
+	pytest --codeblocks README.md

lint.mk

@@ -218,7 +218,7 @@ dynamic = ["version"]
 keywords = ["vuforia", "vws", "client"]
 license = { file = "LICENSE" }
 name = "vws-python"
-readme = { file = "README.rst", content-type = "text/x-rst"}
+readme = { file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"
 dependencies = [
     "VWS-Auth-Tools",
@@ -249,6 +249,7 @@ dev = [
     "pylint==2.17.0 ",
     "pyroma==4.2",
     "pytest-cov==4.0.0",
+    "pytest_codeblocks==0.16.1",
     "pytest==7.2.2 ",
     "ruff==0.0.255",
     "sphinx-autodoc-typehints==1.22",