| Name | vws-python JSON |
| Version |
2024.9.21
JSON |
| download |
| home_page | None |
| Summary | Interact with the Vuforia Web Services (VWS) API. |
| upload_time | 2024-09-21 08:53:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | The MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
client
vuforia
vws
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|Build Status| |codecov| |PyPI| |Documentation Status|
vws-python
==========
Python library for the Vuforia Web Services (VWS) API and the Vuforia
Web Query API.
Installation
------------
.. code-block:: shell
pip install vws-python
This is tested on Python 3.12+. Get in touch with
``adamdangoor@gmail.com`` if you would like to use this with another
language.
Getting Started
---------------
.. code-block:: python
"""Add a target to VWS and then query it."""
import os
import pathlib
import uuid
from vws import VWS, CloudRecoService
server_access_key = os.environ["VWS_SERVER_ACCESS_KEY"]
server_secret_key = os.environ["VWS_SERVER_SECRET_KEY"]
client_access_key = os.environ["VWS_CLIENT_ACCESS_KEY"]
client_secret_key = os.environ["VWS_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_" + uuid.uuid4().hex
image = pathlib.Path("high_quality_image.jpg")
with image.open(mode="rb") as my_image_file:
target_id = vws_client.add_target(
name=name,
width=1,
image=my_image_file,
active_flag=True,
application_metadata=None,
)
vws_client.wait_for_target_processed(target_id=target_id)
with image.open(mode="rb") as my_image_file:
matching_targets = cloud_reco_client.query(image=my_image_file)
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://github.com/VWS-Python/vws-python/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/VWS-Python/vws-python/actions
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/main/graph/badge.svg
:target: https://codecov.io/gh/VWS-Python/vws-python
.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
:target: https://badge.fury.io/py/VWS-Python
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
:target: https://vws-python.readthedocs.io/en/latest/?badge=latest
Raw data
{
"_id": null,
"home_page": null,
"name": "vws-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "client, vuforia, vws",
"author": null,
"author_email": "Adam Dangoor <adamdangoor@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/10/48/c50742e07489c40df919cdfc9cea89610c35d126f10f86bc86ffe33e2604/vws_python-2024.9.21.tar.gz",
"platform": null,
"description": "|Build Status| |codecov| |PyPI| |Documentation Status|\n\nvws-python\n==========\n\nPython library for the Vuforia Web Services (VWS) API and the Vuforia\nWeb Query API.\n\nInstallation\n------------\n\n.. code-block:: shell\n\n pip install vws-python\n\nThis is tested on Python 3.12+. Get in touch with\n``adamdangoor@gmail.com`` if you would like to use this with another\nlanguage.\n\nGetting Started\n---------------\n\n.. code-block:: python\n\n \"\"\"Add a target to VWS and then query it.\"\"\"\n\n import os\n import pathlib\n import uuid\n\n from vws import VWS, CloudRecoService\n\n server_access_key = os.environ[\"VWS_SERVER_ACCESS_KEY\"]\n server_secret_key = os.environ[\"VWS_SERVER_SECRET_KEY\"]\n client_access_key = os.environ[\"VWS_CLIENT_ACCESS_KEY\"]\n client_secret_key = os.environ[\"VWS_CLIENT_SECRET_KEY\"]\n\n vws_client = VWS(\n server_access_key=server_access_key,\n server_secret_key=server_secret_key,\n )\n\n cloud_reco_client = CloudRecoService(\n client_access_key=client_access_key,\n client_secret_key=client_secret_key,\n )\n\n name = \"my_image_name_\" + uuid.uuid4().hex\n\n image = pathlib.Path(\"high_quality_image.jpg\")\n with image.open(mode=\"rb\") as my_image_file:\n target_id = vws_client.add_target(\n name=name,\n width=1,\n image=my_image_file,\n active_flag=True,\n application_metadata=None,\n )\n\n vws_client.wait_for_target_processed(target_id=target_id)\n\n with image.open(mode=\"rb\") as my_image_file:\n matching_targets = cloud_reco_client.query(image=my_image_file)\n\n assert matching_targets[0].target_id == target_id\n\nFull Documentation\n------------------\n\nSee the `full\ndocumentation <https://vws-python.readthedocs.io/en/latest>`__.\n\n.. |Build Status| image:: https://github.com/VWS-Python/vws-python/actions/workflows/ci.yml/badge.svg?branch=main\n :target: https://github.com/VWS-Python/vws-python/actions\n.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/VWS-Python/vws-python\n.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg\n :target: https://badge.fury.io/py/VWS-Python\n.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest\n :target: https://vws-python.readthedocs.io/en/latest/?badge=latest\n",
"bugtrack_url": null,
"license": "The MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Interact with the Vuforia Web Services (VWS) API.",
"version": "2024.9.21",
"project_urls": {
"Documentation": "https://vws-python.readthedocs.io/en/latest/",
"Source": "https://github.com/VWS-Python/vws-python"
},
"split_keywords": [
"client",
" vuforia",
" vws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3db5bad7f41068475536784126a78520ba5ed38bea013383d24b301b57dfbc96",
"md5": "0fb16e6b5f909c66984959a9a04376fa",
"sha256": "73af8ebc34212bdbcab81bef578445163325b6a32a75e7cb24114f671ef8324c"
},
"downloads": -1,
"filename": "vws_python-2024.9.21-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fb16e6b5f909c66984959a9a04376fa",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.12",
"size": 16075,
"upload_time": "2024-09-21T08:53:30",
"upload_time_iso_8601": "2024-09-21T08:53:30.135434Z",
"url": "https://files.pythonhosted.org/packages/3d/b5/bad7f41068475536784126a78520ba5ed38bea013383d24b301b57dfbc96/vws_python-2024.9.21-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1048c50742e07489c40df919cdfc9cea89610c35d126f10f86bc86ffe33e2604",
"md5": "5b089b2523d181b04d75410a1ca1ce56",
"sha256": "579ecf4c921c834c2876ee357b735d9850d2a7b1fd25af201f4f19079f488a9d"
},
"downloads": -1,
"filename": "vws_python-2024.9.21.tar.gz",
"has_sig": false,
"md5_digest": "5b089b2523d181b04d75410a1ca1ce56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 35064,
"upload_time": "2024-09-21T08:53:31",
"upload_time_iso_8601": "2024-09-21T08:53:31.982686Z",
"url": "https://files.pythonhosted.org/packages/10/48/c50742e07489c40df919cdfc9cea89610c35d126f10f86bc86ffe33e2604/vws_python-2024.9.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 08:53:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VWS-Python",
"github_project": "vws-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vws-python"
}
