vws-python 2024.2.19__tar.gz → 2024.9.2__tar.gz

{vws-python-2024.2.19 → vws_python-2024.9.2}/.github/workflows/ci.yml

@@ -33,18 +33,16 @@ jobs:
       - name: "Install dependencies"
         run: |
           curl -LsSf https://astral.sh/uv/install.sh | sh
-          uv venv /home/runner/.venv
-          source /home/runner/.venv/bin/activate
-          uv pip install --upgrade --editable .[dev]
+          uv pip install --system --upgrade --editable .[dev]
 
       - name: "Lint"
         run: |
-          source /home/runner/.venv/bin/activate
-          make lint
+          pre-commit run --all-files --hook-stage commit --verbose
+          pre-commit run --all-files --hook-stage push --verbose
+          pre-commit run --all-files --hook-stage manual --verbose
 
       - name: "Run tests"
         run: |
-          source /home/runner/.venv/bin/activate
           # We run tests against "." and not the tests directory as we test the README
           # and documentation.
           pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests . --cov-report=xml
@@ -54,3 +52,6 @@ jobs:
         with:
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
+
+      - uses: pre-commit-ci/lite-action@v1.0.2
+        if: always()

vws_python-2024.9.2/.github/workflows/dependabot-merge.yml

@@ -0,0 +1,24 @@
+---
+
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

{vws-python-2024.2.19 → vws_python-2024.9.2}/.github/workflows/release.yml

@@ -26,6 +26,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          # See
+          # https://github.com/stefanzweifel/git-auto-commit-action?tab=readme-ov-file#push-to-protected-branches
+          token: ${{ secrets.RELEASE_PAT }}
 
       - name: "Set up Python"
         uses: actions/setup-python@v5
@@ -58,7 +62,7 @@ jobs:
 
       - name: Bump version and push tag
         id: tag_version
-        uses: mathieudutour/github-tag-action@v6.1
+        uses: mathieudutour/github-tag-action@v6.2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           custom_tag: ${{ steps.calver.outputs.release }}
@@ -77,8 +81,9 @@ jobs:
           # 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 pip install build check-wheel-contents
           python -m build --sdist --wheel --outdir dist/ .
+          check-wheel-contents dist/*.whl
 
       # We use PyPI trusted publishing rather than a PyPI API token.
       # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.

{vws-python-2024.2.19 → vws_python-2024.9.2}/.github/workflows/windows-ci.yml

@@ -33,13 +33,10 @@ jobs:
       - name: "Install dependencies"
         run: |
           irm https://astral.sh/uv/install.ps1 | iex
-          uv venv C:/Users/runner/.venv
-          C:/Users/runner/.venv/Scripts/Activate.ps1
-          uv pip install --upgrade --editable .[dev]
+          uv pip install --system --upgrade --editable .[dev]
 
       - name: "Run tests"
         run: |
-          C:/Users/runner/.venv/Scripts/Activate.ps1
           # We run tests against "." and not the tests directory as we test the README
           # and documentation.
           python -m pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests . --cov-report=xml

vws_python-2024.9.2/.pre-commit-config.yaml

@@ -0,0 +1,184 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+ci:
+    # We use system Python, with required dependencies specified in pyproject.toml.
+    # We therefore cannot use those dependencies in pre-commit CI.
+    skip:
+        - actionlint
+        - mypy
+        - check-manifest
+        - pyright
+        - vulture
+        - pyroma
+        - deptry
+        - pylint
+        - ruff-check
+        - ruff-format-check
+        - ruff-check-fix
+        - ruff-format-fix
+        - doc8
+        - interrogate
+        - pyproject-fmt-check
+        - pyproject-fmt-fix
+        - linkcheck
+        - spelling
+        - docs
+        - pyright-verifytypes
+
+default_install_hook_types: [pre-commit, pre-push, commit-msg]
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-case-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-merge-conflict
+    -   id: check-shebang-scripts-are-executable
+    -   id: check-symlinks
+    -   id: check-toml
+    -   id: check-vcs-permalinks
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: file-contents-sorter
+        files: spelling_private_dict\.txt$
+    -   id: trailing-whitespace
+-   repo: local
+    hooks:
+    -   id: actionlint
+        name: actionlint
+        entry: actionlint
+        language: system
+        pass_filenames: false
+        types_or: [yaml]
+
+    -   id: mypy
+        name: mypy
+        stages: [push]
+        entry: mypy .
+        language: system
+        types_or: [python, toml]
+        pass_filenames: false
+
+    -   id: check-manifest
+        name: check-manifest
+        stages: [push]
+        entry: check-manifest .
+        language: system
+        pass_filenames: false
+
+    -   id: pyright
+        name: pyright
+        stages: [push]
+        entry: pyright .
+        language: system
+        types_or: [python, toml]
+        pass_filenames: false
+
+    -   id: vulture
+        name: vulture
+        entry: vulture --min-confidence 100 --exclude .eggs
+        language: system
+        types_or: [python]
+
+    -   id: pyroma
+        name: pyroma
+        entry: pyroma --min 10 .
+        language: system
+        pass_filenames: false
+        types_or: [toml]
+
+    -   id: deptry
+        name: deptry
+        entry: deptry src/
+        language: system
+        pass_filenames: false
+
+    -   id: pylint
+        name: pylint
+        entry: pylint *.py src/ tests/ docs/
+        language: system
+        stages: [manual]
+        pass_filenames: false
+
+    -   id: ruff-check
+        name: Ruff check
+        entry: ruff check
+        language: system
+        types_or: [python]
+
+    -   id: ruff-format-check
+        name: Ruff format check
+        entry: ruff format --check
+        language: system
+        types_or: [python]
+
+    -   id: ruff-check-fix
+        name: Ruff check fix
+        entry: ruff check --fix
+        language: system
+        types_or: [python]
+
+    -   id: ruff-format-fix
+        name: Ruff format
+        entry: ruff format
+        language: system
+        types_or: [python]
+
+    -   id: doc8
+        name: doc8
+        entry: doc8
+        language: system
+        types_or: [rst]
+
+    -   id: interrogate
+        name: interrogate
+        entry: interrogate
+        language: system
+        types_or: [python]
+
+    -   id: pyproject-fmt-check
+        name: pyproject-fmt check
+        entry: pyproject-fmt --check
+        language: system
+        types_or: [toml]
+        files: pyproject.toml
+
+    -   id: pyproject-fmt-fix
+        name: pyproject-fmt
+        entry: pyproject-fmt
+        language: system
+        types_or: [toml]
+        files: pyproject.toml
+
+    -   id: linkcheck
+        name: linkcheck
+        entry: make -C docs/ linkcheck SPHINXOPTS=-W
+        language: system
+        types_or: [rst]
+        stages: [manual]
+        pass_filenames: false
+
+    -   id: spelling
+        name: spelling
+        entry: make -C docs/ spelling SPHINXOPTS=-W
+        language: system
+        types_or: [rst]
+        stages: [manual]
+        pass_filenames: false
+
+    -   id: docs
+        name: Build Documentation
+        entry: make docs
+        language: system
+        stages: [manual]
+        pass_filenames: false
+
+    -   id: pyright-verifytypes
+        name: pyright-verifytypes
+        stages: [push]
+        entry: pyright --verifytypes vws
+        language: system
+        pass_filenames: false
+        types_or: [python]

{vws-python-2024.2.19 → vws_python-2024.9.2}/CHANGELOG.rst

@@ -4,9 +4,18 @@ Changelog
 Next
 ----
 
+2024.09.02
+------------
+
+* Breaking change: Exception names now end with ``Error``.
+* Use a timeout (30 seconds) when making requests to the VWS API.
+* Type hint changes: images are now ``io.BytesIO`` instances or ``io.BufferedRandom``.
+
 2024.02.19
 ------------
 
+* Add exception response attribute to ``vws.exceptions.custom_exceptions.RequestEntityTooLarge``.
+
 2024.02.06
 ------------
 

{vws-python-2024.2.19 → vws_python-2024.9.2}/LICENSE

@@ -17,4 +17,3 @@ 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-2024.9.2/Makefile

@@ -0,0 +1,12 @@
+SHELL := /bin/bash -euxo pipefail
+
+# Treat Sphinx warnings as errors
+SPHINXOPTS := -W
+
+.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-2024.2.19/src/vws_python.egg-info → vws_python-2024.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vws-python
-Version: 2024.2.19
+Version: 2024.9.2
 Summary: Interact with the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License: The MIT License
@@ -23,7 +23,6 @@ License: The MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
         
-        
 Project-URL: Documentation, https://vws-python.readthedocs.io/en/latest/
 Project-URL: Source, https://github.com/VWS-Python/vws-python
 Keywords: client,vuforia,vws
@@ -36,38 +35,40 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: beartype>=0.18.5
 Requires-Dist: requests
 Requires-Dist: urllib3
-Requires-Dist: VWS-Auth-Tools
+Requires-Dist: vws-auth-tools
 Provides-Extra: dev
-Requires-Dist: actionlint-py==1.6.26.11; extra == "dev"
+Requires-Dist: actionlint-py==1.7.1.15; extra == "dev"
 Requires-Dist: check-manifest==0.49; extra == "dev"
+Requires-Dist: deptry==0.20.0; extra == "dev"
 Requires-Dist: doc8==1.1.1; extra == "dev"
-Requires-Dist: freezegun==1.4.0; extra == "dev"
-Requires-Dist: furo==2024.1.29; extra == "dev"
-Requires-Dist: mypy==1.8.0; extra == "dev"
-Requires-Dist: pip_check_reqs==2.5.3; extra == "dev"
+Requires-Dist: freezegun==1.5.1; extra == "dev"
+Requires-Dist: furo==2024.8.6; extra == "dev"
+Requires-Dist: interrogate==1.7.0; extra == "dev"
+Requires-Dist: mypy==1.11.2; extra == "dev"
+Requires-Dist: pre-commit==3.8.0; extra == "dev"
 Requires-Dist: pydocstyle==6.3; extra == "dev"
 Requires-Dist: pyenchant==3.2.2; extra == "dev"
-Requires-Dist: Pygments==2.17.2; extra == "dev"
-Requires-Dist: pylint==3.0.3; extra == "dev"
-Requires-Dist: pyproject-fmt==1.7.0; extra == "dev"
-Requires-Dist: pyright==1.1.350; extra == "dev"
+Requires-Dist: pygments==2.18.0; extra == "dev"
+Requires-Dist: pylint==3.2.7; extra == "dev"
+Requires-Dist: pyproject-fmt==2.2.1; extra == "dev"
+Requires-Dist: pyright==1.1.378; extra == "dev"
 Requires-Dist: pyroma==4.2; extra == "dev"
-Requires-Dist: pytest==8.0.1; extra == "dev"
-Requires-Dist: pytest-cov==4.1; extra == "dev"
-Requires-Dist: PyYAML==6.0.1; extra == "dev"
-Requires-Dist: ruff==0.2.2; extra == "dev"
-Requires-Dist: Sphinx==7.2.6; extra == "dev"
-Requires-Dist: sphinx-prompt==1.8; extra == "dev"
-Requires-Dist: Sphinx-Substitution-Extensions==2022.2.16; extra == "dev"
+Requires-Dist: pytest==8.3.2; extra == "dev"
+Requires-Dist: pytest-cov==5.0.0; extra == "dev"
+Requires-Dist: pyyaml==6.0.2; extra == "dev"
+Requires-Dist: ruff==0.6.3; extra == "dev"
+Requires-Dist: sphinx==8.0.2; extra == "dev"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2024.8.6; extra == "dev"
 Requires-Dist: sphinxcontrib-spelling==8; extra == "dev"
-Requires-Dist: sybil==6.0.3; extra == "dev"
-Requires-Dist: types-requests==2.31.0.20240125; extra == "dev"
-Requires-Dist: uv==0.1.5; extra == "dev"
+Requires-Dist: sybil==6.1.1; extra == "dev"
+Requires-Dist: types-requests==2.32.0.20240712; extra == "dev"
 Requires-Dist: vulture==2.11; extra == "dev"
-Requires-Dist: VWS-Python-Mock==2024.2.16; extra == "dev"
-Requires-Dist: VWS-Test-Fixtures==2023.3.5; extra == "dev"
+Requires-Dist: vws-python-mock==2024.8.30; extra == "dev"
+Requires-Dist: vws-test-fixtures==2023.3.5; extra == "dev"
 
 |Build Status| |codecov| |PyPI| |Documentation Status|
 
@@ -91,34 +92,6 @@ language.
 Getting Started
 ---------------
 
-.. invisible-code-block: python
-
-   import contextlib
-   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)
-   stack = contextlib.ExitStack()
-   stack.enter_context(mock)
-
-   # 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)
-
-
 .. code-block:: python
 
    import pathlib
@@ -154,11 +127,6 @@ Getting Started
 
    assert matching_targets[0].target_id == target_id
 
-.. invisible-code-block: python
-   new_image = pathlib.Path('high_quality_image.jpg')
-   new_image.unlink()
-   stack.close()
-
 Full Documentation
 ------------------
 

{vws-python-2024.2.19 → vws_python-2024.9.2}/README.rst

@@ -20,34 +20,6 @@ language.
 Getting Started
 ---------------
 
-.. invisible-code-block: python
-
-   import contextlib
-   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)
-   stack = contextlib.ExitStack()
-   stack.enter_context(mock)
-
-   # 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)
-
-
 .. code-block:: python
 
    import pathlib
@@ -83,11 +55,6 @@ Getting Started
 
    assert matching_targets[0].target_id == target_id
 
-.. invisible-code-block: python
-   new_image = pathlib.Path('high_quality_image.jpg')
-   new_image.unlink()
-   stack.close()
-
 Full Documentation
 ------------------
 

vws_python-2024.9.2/conftest.py

@@ -0,0 +1,71 @@
+"""Setup for Sybil."""
+
+import io
+from collections.abc import Generator
+from doctest import ELLIPSIS
+from pathlib import Path
+
+import pytest
+from beartype import beartype
+from mock_vws import MockVWS
+from mock_vws.database import VuforiaDatabase
+from sybil import Sybil
+from sybil.parsers.rest import (
+    ClearNamespaceParser,
+    DocTestParser,
+    PythonCodeBlockParser,
+)
+
+
+def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
+    """
+    Apply the beartype decorator to all collected test functions.
+    """
+    for item in items:
+        if isinstance(item, pytest.Function):
+            item.obj = beartype(obj=item.obj)
+
+
+@pytest.fixture
+def make_image_file(
+    high_quality_image: io.BytesIO,
+) -> Generator[None, None, None]:
+    """
+    Make an image file available in the test directory.
+    The path of this file matches the path in the documentation.
+    """
+    new_image = Path("high_quality_image.jpg")
+    buffer = high_quality_image.getvalue()
+    new_image.write_bytes(data=buffer)
+    yield
+    new_image.unlink()
+
+
+@pytest.fixture
+def mock_vws() -> Generator[None, None, None]:
+    """
+    Yield a mock VWS.
+
+    The keys used here match the keys in the documentation.
+    """
+    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]",
+    )
+    # We use a low processing time so that tests run quickly.
+    with MockVWS(processing_time_seconds=0.2) as mock:
+        mock.add_database(database=database)
+        yield
+
+
+pytest_collect_file = Sybil(
+    parsers=[
+        ClearNamespaceParser(),
+        DocTestParser(optionflags=ELLIPSIS),
+        PythonCodeBlockParser(),
+    ],
+    patterns=["*.rst", "*.py"],
+    fixtures=["make_image_file", "mock_vws"],
+).pytest()

{vws-python-2024.2.19 → vws_python-2024.9.2}/docs/source/conf.py

@@ -12,10 +12,10 @@ project = "VWS-Python"
 author = "Adam Dangoor"
 
 extensions = [
+    "sphinx_copybutton",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinx-prompt",
     "sphinx_substitution_extensions",
     "sphinxcontrib.spelling",
 ]
@@ -27,6 +27,10 @@ master_doc = "index"
 year = datetime.datetime.now(tz=datetime.UTC).year
 project_copyright = f"{year}, {author}"
 
+# Exclude the prompt from copied code with sphinx_copybutton.
+# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies.
+copybutton_exclude = ".linenos, .gp"
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
@@ -58,6 +62,12 @@ intersphinx_mapping = {
     "python": ("https://docs.python.org/3.12", None),
 }
 nitpicky = True
+nitpick_ignore = (
+    ("py:class", "BytesIO"),
+    ("py:class", "BufferedRandom"),
+    ("py:class", "_io.BytesIO"),
+    ("py:class", "_io.BufferedRandom"),
+)
 warning_is_error = True
 
 autoclass_content = "both"

{vws-python-2024.2.19 → vws_python-2024.9.2}/docs/source/contributing.rst

@@ -10,46 +10,50 @@ Install contribution dependencies
 
 Install Python dependencies in a virtual environment.
 
-.. prompt:: bash
+.. code-block:: console
 
-   pip install --editable '.[dev]'
+   $ pip install --editable '.[dev]'
 
 Spell checking requires ``enchant``.
-This can be installed on macOS, for example, with `Homebrew <https://brew.sh>`__:
+This can be installed on macOS, for example, with `Homebrew`_:
 
-.. prompt:: bash
+.. code-block:: console
 
-   brew install enchant
+   $ brew install enchant
 
 and on Ubuntu with ``apt``:
 
-.. prompt:: bash
+.. code-block:: console
 
-   apt-get install -y enchant
+   $ apt-get install -y enchant
 
-Linting
--------
+Install ``pre-commit`` hooks:
+
+.. code-block:: console
 
-Run lint tools:
+   $ pre-commit install
 
-.. prompt:: bash
+Linting
+-------
 
-   make lint
+Run lint tools either by committing, or with:
 
-To fix some lint errors, run the following:
+.. code-block:: console
 
-.. prompt:: bash
+   $ pre-commit run --all-files --hook-stage commit --verbose
+   $ pre-commit run --all-files --hook-stage push --verbose
+   $ pre-commit run --all-files --hook-stage manual --verbose
 
-   make fix-lint
+.. _Homebrew: https://brew.sh
 
 Running tests
 -------------
 
 Run ``pytest``:
 
-.. prompt:: bash
+.. code-block:: console
 
-   pytest
+   $ pytest
 
 Documentation
 -------------
@@ -58,10 +62,10 @@ Documentation is built on Read the Docs.
 
 Run the following commands to build and view documentation locally:
 
-.. prompt:: bash
+.. code-block:: console
 
-   make docs
-   make open-docs
+   $ make docs
+   $ make open-docs
 
 Continuous integration
 ----------------------