vws-python 2023.3.5__tar.gz

vws-python-2023.3.5/.git_archival.txt

@@ -0,0 +1 @@
+ref-names: $Format:%D$

vws-python-2023.3.5/.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

vws-python-2023.3.5/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/requirements"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

vws-python-2023.3.5/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+---
+
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    # Run at 1:00 every day
+    - cron: '0 1 * * *'
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        platform: [ubuntu-latest]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          # This is like the example but we use ``*requirements.txt`` rather
+          # than ``requirements.txt`` because we have multiple requirements
+          # files.
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: "Install dependencies"
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          # We use '--ignore-installed' to avoid GitHub's cache which can cause
+          # issues - we have seen packages from this cache be cause trouble with
+          # pip-extra-reqs.
+          python -m pip install --ignore-installed --upgrade --editable .[dev]
+
+      - name: "Lint"
+        run: |
+          make lint
+
+      - name: "Run tests"
+        run: |
+          pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests tests/ --cov-report=xml
+
+      - name: "Upload coverage to Codecov"
+        uses: "codecov/codecov-action@v3"

vws-python-2023.3.5/.github/workflows/release.yml

@@ -0,0 +1,76 @@
+---
+
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    name: Publish a release
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: "Calver calculate version"
+        uses: StephaneBour/actions-calver@master
+        id: calver
+        with:
+          date_format: "%Y.%m.%d"
+          release: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Update changelog"
+        uses: jacobtomlinson/gha-find-replace@v3
+        env:
+          NEXT_VERSION: ${{ steps.calver.outputs.release }}
+        with:
+          find: "Next\n----"
+          replace: "Next\n----\n\n${{ env.NEXT_VERSION }}\n------------"
+          include: "CHANGELOG.rst"
+          regex: false
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        id: commit
+        with:
+          commit_message: Bump CHANGELOG
+
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          custom_tag: ${{ steps.calver.outputs.release }}
+          tag_prefix: ""
+          commit_sha: ${{ steps.commit.outputs.commit_hash }}
+
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}
+
+      - name: Build a binary wheel and a source tarball
+        run: |
+          # Checkout the latest tag - the one we just created.
+          git fetch --tags
+          git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
+          python -m pip install build
+          python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

vws-python-2023.3.5/.github/workflows/windows-ci.yml

@@ -0,0 +1,52 @@
+---
+
+name: Windows CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    # Run at 1:00 every day
+    - cron: '0 1 * * *'
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        platform: [windows-latest]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: actions/cache@v3
+        with:
+          path: ~\AppData\Local\pip\Cache
+          # This is like the example but we use ``*requirements.txt`` rather
+          # than ``requirements.txt`` because we have multiple requirements
+          # files.
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: "Install dependencies"
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          # We use '--ignore-installed' to avoid GitHub's cache which can cause
+          # issues - we have seen packages from this cache be cause trouble with
+          # pip-extra-reqs.
+          python -m pip install --ignore-installed --upgrade --editable .[dev]
+
+      - name: "Run tests"
+        run: |
+          pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests tests/ --cov-report=xml

vws-python-2023.3.5/.gitignore

@@ -0,0 +1,111 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# Files containing secrets
+vuforia_secrets.env
+ci_secrets/
+secrets.tar
+
+# mypy
+.mypy_cache/
+
+# macOS attributes
+*.DS_Store
+
+# pyre
+.pyre/
+
+# pytest
+.pytest_cache/
+
+# setuptools_scm
+src/*/_setuptools_scm_version.txt

vws-python-2023.3.5/CHANGELOG.rst

@@ -0,0 +1,48 @@
+Changelog
+=========
+
+Next
+----
+
+2023.03.05
+------------
+
+2021.03.28.2
+------------
+
+2021.03.28.1
+------------
+
+2021.03.28.0
+------------
+
+* Breaking change: The ``vws.exceptions.cloud_reco_exceptions.MatchProcessing`` is now ``vws.exceptions.custom_exceptions.ActiveMatchingTargetsDeleteProcessing``.
+* Added new exception ``vws.exceptions.custom_exceptions.RequestEntityTooLarge``.
+* Add better exception handling when querying a server which does not serve the Vuforia API.
+
+2020.09.07.0
+------------
+
+* Breaking change: Move exceptions and create base exceptions.
+  It is now possible to, for example, catch
+  ``vws.exceptions.base_exceptions.VWSException`` to catch many of the
+  exceptions raised by the ``VWS`` client.
+  Credit to ``@laymonage`` for this change.
+
+2020.08.21.0
+------------
+
+* Change the return type of ``vws_client.get_target_record`` to match what is returned by the web API.
+
+2020.06.19.0
+------------
+
+2020.03.21.0
+------------
+
+* Add Windows support.
+
+2019.11.23.0
+------------
+
+* Make ``active_flag`` and ``application_metadata`` required on ``add_target``.

vws-python-2023.3.5/CODE_OF_CONDUCT.rst

@@ -0,0 +1,47 @@
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to creating a positive environment include:
+
+Using welcoming and inclusive language
+Being respectful of differing viewpoints and experiences
+Gracefully accepting constructive criticism
+Focusing on what is best for the community
+Showing empathy towards other community members
+Examples of unacceptable behavior by participants include:
+
+The use of sexualized language or imagery and unwelcome sexual attention or advances
+Trolling, insulting/derogatory comments, and personal or political attacks
+Public or private harassment
+Publishing others' private information, such as a physical or electronic address, without explicit permission
+Other conduct which could reasonably be considered inappropriate in a professional setting
+Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+Scope
+-----
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at adamdangoor@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.

vws-python-2023.3.5/LICENSE

@@ -0,0 +1,20 @@
+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.
+

vws-python-2023.3.5/MANIFEST.in

@@ -0,0 +1,3 @@
+include src/vws/py.typed
+include requirements/*.txt
+include pyproject.toml

vws-python-2023.3.5/Makefile

@@ -0,0 +1,34 @@
+SHELL := /bin/bash -euxo pipefail
+
+include lint.mk
+
+# Treat Sphinx warnings as errors
+SPHINXOPTS := -W
+
+.PHONY: lint
+lint: \
+    black \
+    check-manifest \
+    doc8 \
+    linkcheck \
+    mypy \
+    ruff \
+    pip-extra-reqs \
+    pip-missing-reqs \
+    pyroma \
+    spelling \
+    vulture \
+    pylint
+
+.PHONY: fix-lint
+fix-lint: \
+    fix-black \
+    fix-ruff
+
+.PHONY: docs
+docs:
+	make -C docs clean html SPHINXOPTS=$(SPHINXOPTS)
+
+.PHONY: open-docs
+open-docs:
+	python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'

vws-python-2023.3.5/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: vws-python
+Version: 2023.3.5
+Summary: Interact with the Vuforia Web Services (VWS) API.
+Author-email: Adam Dangoor <adamdangoor@gmail.com>
+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.
+        
+        
+Project-URL: Source, https://github.com/VWS-Python/vws-python
+Project-URL: Documentation, https://vws-python.readthedocs.io/en/latest/
+Keywords: vuforia,vws,client
+Classifier: Operating System :: POSIX
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3
+Description-Content-Type: text/x-rst
+Provides-Extra: dev
+License-File: LICENSE
+
+|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:: 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
+---------------
+
+.. code:: python
+
+   import io
+
+   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'
+
+   with open('/path/to/image.png', '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
+
+
+Full Documentation
+------------------
+
+See the `full documentation <https://vws-python.readthedocs.io/en/latest>`__.
+
+.. |Build Status| image:: https://github.com/VWS-Python/vws-python/workflows/CI/badge.svg
+   :target: https://github.com/VWS-Python/vws-python/actions
+.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/VWS-Python/vws-python
+.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
+   :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
+   :target: https://badge.fury.io/py/VWS-Python

vws-python-2023.3.5/README.rst

@@ -0,0 +1,71 @@
+|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:: 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
+---------------
+
+.. code:: python
+
+   import io
+
+   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'
+
+   with open('/path/to/image.png', '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
+
+
+Full Documentation
+------------------
+
+See the `full documentation <https://vws-python.readthedocs.io/en/latest>`__.
+
+.. |Build Status| image:: https://github.com/VWS-Python/vws-python/workflows/CI/badge.svg
+   :target: https://github.com/VWS-Python/vws-python/actions
+.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/VWS-Python/vws-python
+.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
+   :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
+   :target: https://badge.fury.io/py/VWS-Python

vws-python-2023.3.5/codecov.yaml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    patch:
+      default:
+        # Require 100% test coverage.
+        target: 100%

vws-python-2023.3.5/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = VWSPYTHON
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

vws-python-2023.3.5/docs/source/__init__.py

@@ -0,0 +1 @@
+"""Documentation."""