vws-python-mock 2026.4.26__tar.gz → 2026.8.4__tar.gz

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/.github/workflows/docker-build.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
@@ -35,11 +35,11 @@ jobs:
         uses: docker/setup-buildx-action@v4
 
       - name: Check Docker bake definition
-        uses: docker/bake-action@v7.1.0
+        uses: docker/bake-action@v7.3.0
         with:
           call: check
 
       - name: Build Docker images
-        uses: docker/bake-action@v7.1.0
+        uses: docker/bake-action@v7.3.0
         with:
           push: false

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/.github/workflows/lint.yml

@@ -25,12 +25,12 @@ jobs:
     runs-on: ${{ matrix.platform }}
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -42,6 +42,9 @@ jobs:
         run: uv run --extra=dev prek run --all-files --hook-stage ${{ matrix.hook-stage }}
           --verbose
         env:
+          # Avoid intermittent uv distribution cache rename failures while
+          # prek installs hook environments on Windows.
+          UV_NO_CACHE: '1'
           UV_PYTHON: ${{ matrix.python-version }}
 
       - uses: pre-commit-ci/lite-action@v1.1.0

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
       tag: ${{ steps.tag_version.outputs.new_tag }}
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           # Fetch all history including tags.
           # Needed to find the latest tag.
@@ -34,6 +34,12 @@ jobs:
           # The default GITHUB_TOKEN cannot bypass rulesets.
           token: ${{ secrets.RELEASE_PAT }}
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v9.0.0
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
+
       - name: Calver calculate version
         uses: StephaneBour/actions-calver@master
         id: calver
@@ -43,41 +49,27 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Get the changelog underline
-        id: changelog_underline
+      # towncrier writes the rendered notes to stdout (informational
+      # chatter goes to stderr), so this is the curated release body for
+      # this version, not github-tag-action's commit-derived changelog.
+      - name: Generate the GitHub release notes
         env:
           RELEASE: ${{ steps.calver.outputs.release }}
-        run: |
-          underline="$(echo "$RELEASE" | tr -c '\n' '-')"
-          echo "underline=${underline}" >> "$GITHUB_OUTPUT"
+        run: uv run --extra=release towncrier build --draft --version "$RELEASE" >
+          release-notes.md
 
-      - name: Update changelog
-        id: update_changelog
-        uses: jacobtomlinson/gha-find-replace@v3
-        with:
-          find: "Next\n----"
-          replace: |
-            Next
-            ----
-
-            ${{ steps.calver.outputs.release }}
-            ${{ steps.changelog_underline.outputs.underline }}
-          include: CHANGELOG.rst
-          regex: false
-
-      - name: Check Update changelog was modified
+      # Assemble the same fragments into CHANGELOG.rst under a new
+      # ``$RELEASE`` section and delete the consumed fragment files.
+      - name: Update the changelog
         env:
-          MODIFIED_FILES: ${{ steps.update_changelog.outputs.modifiedFiles }}
-        run: |
-          if [ "$MODIFIED_FILES" = "0" ]; then
-            echo "Error: No files were modified when updating changelog"
-            exit 1
-          fi
+          RELEASE: ${{ steps.calver.outputs.release }}
+        run: uv run --extra=release towncrier build --yes --version "$RELEASE"
+
       - uses: stefanzweifel/git-auto-commit-action@v7
         id: commit
         with:
           commit_message: Bump CHANGELOG
-          file_pattern: CHANGELOG.rst
+          file_pattern: CHANGELOG.rst newsfragments
           # Error if there are no changes.
           skip_dirty_check: true
 
@@ -96,7 +88,7 @@ jobs:
           tag: ${{ steps.tag_version.outputs.new_tag }}
           makeLatest: true
           name: Release ${{ steps.tag_version.outputs.new_tag }}
-          body: ${{ steps.tag_version.outputs.changelog }}
+          bodyFile: release-notes.md
 
   pypi:
     name: Publish to PyPI
@@ -113,7 +105,7 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           ref: ${{ needs.release.outputs.tag }}
           # Fetch all history including tags.
@@ -122,7 +114,7 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -149,13 +141,13 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           ref: ${{ needs.release.outputs.tag }}
           persist-credentials: false
 
       - name: Login to GHCR
-        uses: docker/login-action@v4
+        uses: docker/login-action@v4.6.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -168,7 +160,7 @@ jobs:
         uses: docker/setup-qemu-action@v4
 
       - name: Build and push Docker images
-        uses: docker/bake-action@v7.1.0
+        uses: docker/bake-action@v7.3.0
         with:
           push: true
         env:

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/.github/workflows/test.yml

@@ -115,6 +115,7 @@ jobs:
           - tests/mock_vws/test_requests_mock_usage.py
           - tests/mock_vws/test_respx_mock_usage.py
           - tests/mock_vws/test_flask_app_usage.py
+          - tests/mock_vws/test_model_target_web_api.py
           - tests/mock_vws/test_vumark_generation_api.py
           - tests/mock_vws/test_target_validators.py
           - tests/mock_vws/test_docker.py
@@ -123,12 +124,12 @@ jobs:
           - docs/
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -195,12 +196,12 @@ jobs:
         platform: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -240,12 +241,12 @@ jobs:
         python-version: ['3.14']
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -254,17 +255,29 @@ jobs:
         run: |
           cp ./vuforia_secrets.env.example ./vuforia_secrets.env
 
+      - name: Start Docker
+        shell: pwsh
+        run: |
+          $service = Get-Service docker -ErrorAction Stop
+          if ($service.Status -ne "Running") {
+            Start-Service docker
+          }
+          $deadline = (Get-Date).AddMinutes(2)
+          do {
+            docker info
+            if ($LASTEXITCODE -eq 0) {
+              exit 0
+            }
+            Start-Sleep -Seconds 5
+          } while ((Get-Date) -lt $deadline)
+          docker info
+
       - name: Run tests
         shell: bash
         run: |
           # We use pytest-xdist to make this run much faster.
           # The downside is that we cannot use -s / --capture=no.
           #
-          # We use coverage to collect coverage data but we currently
-          # do not upload / use it because combining Windows and Linux
-          # coverage is challenging.
-          #
-          # We therefore have a few ``# pragma: no cover`` statements.
           uv run --extra=dev \
             coverage run -m pytest \
               --skip-real \
@@ -275,6 +288,14 @@ jobs:
         env:
           UV_PYTHON: ${{ matrix.python-version }}
 
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-data-windows-${{ matrix.python-version }}
+          path: .coverage.*
+          include-hidden-files: true
+          if-no-files-found: error
+
   coverage:
     name: Combine & check coverage
     needs: [ci-tests, skip-tests, windows-tests]
@@ -282,12 +303,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v9.0.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/.pre-commit-config.yaml

@@ -9,6 +9,7 @@ ci:
   skip:
     - actionlint
     - sphinx-lint
+    - strict-kwargs-fix
     - check-manifest
     - custom-linters
     - deptry
@@ -174,7 +175,7 @@ repos:
       - id: mypy
         name: mypy
         stages: [pre-push]
-        entry: uv run --extra=dev -m mypy
+        entry: uv run --extra=dev -m mypy --num-workers=4
         language: python
         types_or: [python, toml]
         pass_filenames: false
@@ -185,7 +186,8 @@ repos:
       - id: mypy-docs
         name: mypy-docs
         stages: [pre-push]
-        entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="mypy"
+        entry: uv run --extra=dev doccmd --no-write-to-file --language=python --command="mypy
+          --num-workers=4"
         language: python
         types_or: [markdown, rst]
 
@@ -337,6 +339,16 @@ repos:
           - *uv_version
         stages: [pre-commit]
 
+      - id: strict-kwargs-fix
+        name: strict-kwargs
+        entry: uv run --extra=dev strict-kwargs check --fix
+        language: python
+        types_or: [python]
+        additional_dependencies:
+          - *uv_version
+        stages: [pre-commit]
+        require_serial: true
+
       - id: doc8
         name: doc8
         entry: uv run --extra=dev -m doc8

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/CHANGELOG.rst

@@ -1,8 +1,28 @@
 Changelog
 =========
 
-Next
-----
+.. towncrier release notes start
+
+2026.08.04
+----------
+
+- Cloud databases with ``request_quota=0`` now return a
+  ``RequestQuotaReached`` response from VWS endpoints.
+
+- Add a mock implementation of the Model Target Web API, including OAuth2 token creation, standard and advanced dataset creation, status polling, dataset download, and deletion.
+
+- Improve Model Target Web API mock authentication failure responses.
+
+- Match real Vuforia Model Target dataset creation validation error shape, including per-request UUID, details list, and status codes (415 for unsupported media type, 400 with ``BAD_REQUEST`` validation details).
+
+- Match real Vuforia Model Target unknown-dataset response shape (``NOT_FOUND`` code, ``Could not find a model-view database with uuid <uuid>`` message, ``userId:`` target).
+
+- Make synthetic Model Target dataset zip downloads byte-for-byte reproducible.
+
+- Match real Vuforia Model Target Web API error responses for invalid request bodies, invalid dataset creation payloads, unknown datasets, and downloads of still-processing datasets.
+
+- Add configurable ``TargetQuotaReached``, ``ProjectSuspended``, and
+  ``ProjectHasNoAPIAccess`` responses from VWS endpoints.
 
 2026.04.26
 ----------

{vws_python_mock-2026.4.26/src/vws_python_mock.egg-info → vws_python_mock-2026.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.4.26
+Version: 2026.8.4
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT
@@ -37,59 +37,63 @@ Provides-Extra: dev
 Requires-Dist: actionlint-py==1.7.12.24; extra == "dev"
 Requires-Dist: check-manifest==0.51; extra == "dev"
 Requires-Dist: check-wheel-contents==0.6.3; extra == "dev"
-Requires-Dist: coverage==7.13.5; extra == "dev"
+Requires-Dist: coverage==7.15.2; extra == "dev"
 Requires-Dist: deptry==0.25.1; extra == "dev"
 Requires-Dist: dirty-equals==0.11; extra == "dev"
 Requires-Dist: doc8==2.0.0; extra == "dev"
-Requires-Dist: doccmd==2026.3.26.2; extra == "dev"
-Requires-Dist: docker==7.1.0; extra == "dev"
+Requires-Dist: doccmd==2026.7.19; extra == "dev"
+Requires-Dist: docker==7.2.0; extra == "dev"
 Requires-Dist: freezegun==1.5.5; extra == "dev"
 Requires-Dist: furo==2025.12.19; extra == "dev"
 Requires-Dist: interrogate==1.7.0; extra == "dev"
-Requires-Dist: mypy[faster-cache]==1.20.2; extra == "dev"
-Requires-Dist: mypy-strict-kwargs==2026.1.12; extra == "dev"
-Requires-Dist: prek==0.3.10; extra == "dev"
-Requires-Dist: pydocstringformatter==0.7.5; extra == "dev"
+Requires-Dist: mypy[faster-cache]==2.3.0; extra == "dev"
+Requires-Dist: mypy-strict-kwargs==2026.7.19.1; extra == "dev"
+Requires-Dist: prek==0.4.11; extra == "dev"
+Requires-Dist: pydocstringformatter==1.0.0; extra == "dev"
 Requires-Dist: pydocstyle==6.3; extra == "dev"
-Requires-Dist: pylint[spelling]==4.0.5; extra == "dev"
+Requires-Dist: pylint[spelling]==4.0.6; extra == "dev"
 Requires-Dist: pylint-per-file-ignores==3.2.1; extra == "dev"
-Requires-Dist: pyproject-fmt==2.21.1; extra == "dev"
-Requires-Dist: pyrefly==0.62.0; extra == "dev"
-Requires-Dist: pyright==1.1.409; extra == "dev"
+Requires-Dist: pyproject-fmt==2.26.0; extra == "dev"
+Requires-Dist: pyrefly==1.1.1; extra == "dev"
+Requires-Dist: pyright==1.1.411; extra == "dev"
 Requires-Dist: pyroma==5.0.1; extra == "dev"
-Requires-Dist: pytest==9.0.3; extra == "dev"
+Requires-Dist: pytest==9.1.1; extra == "dev"
 Requires-Dist: pytest-beartype-tests==2026.4.26; extra == "dev"
 Requires-Dist: pytest-retry==1.7.0; extra == "dev"
 Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
 Requires-Dist: pyyaml==6.0.3; extra == "dev"
 Requires-Dist: requests-mock-flask==2026.4.2; extra == "dev"
-Requires-Dist: ruff==0.15.11; extra == "dev"
+Requires-Dist: ruff==0.16.1; extra == "dev"
 Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
-Requires-Dist: shfmt-py==3.12.0.2; extra == "dev"
+Requires-Dist: shfmt-py==4.0.0; extra == "dev"
 Requires-Dist: sphinx==9.1.0; extra == "dev"
 Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
 Requires-Dist: sphinx-lint==1.0.2; extra == "dev"
 Requires-Dist: sphinx-paramlinks==0.6; extra == "dev"
 Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
-Requires-Dist: sphinx-substitution-extensions==2026.1.12; extra == "dev"
-Requires-Dist: sphinx-toolbox==4.2.0rc1; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2026.6.17; extra == "dev"
+Requires-Dist: sphinx-toolbox==4.3.0; extra == "dev"
 Requires-Dist: sphinxcontrib-httpdomain==2.0.0; extra == "dev"
 Requires-Dist: sphinxcontrib-spelling==8.0.2; extra == "dev"
-Requires-Dist: sybil==10.0.1; extra == "dev"
+Requires-Dist: sphinxcontrib-towncrier==0.5.0a0; extra == "dev"
+Requires-Dist: strict-kwargs==2026.7.24; extra == "dev"
+Requires-Dist: sybil==10.1.0; extra == "dev"
 Requires-Dist: tenacity==9.1.4; extra == "dev"
-Requires-Dist: ty==0.0.32; extra == "dev"
-Requires-Dist: types-docker==7.1.0.20260409; extra == "dev"
-Requires-Dist: types-pyyaml==6.0.12.20260408; extra == "dev"
-Requires-Dist: types-requests==2.33.0.20260408; extra == "dev"
-Requires-Dist: urllib3==2.6.3; extra == "dev"
+Requires-Dist: towncrier==25.8.0; extra == "dev"
+Requires-Dist: ty==0.0.65; extra == "dev"
+Requires-Dist: types-docker==7.2.0.20260728; extra == "dev"
+Requires-Dist: types-pyyaml==6.0.12.20260724; extra == "dev"
+Requires-Dist: types-requests==2.33.0.20260712; extra == "dev"
+Requires-Dist: urllib3==2.7.0; extra == "dev"
 Requires-Dist: vulture==2.16; extra == "dev"
 Requires-Dist: vws-python==2026.2.25.1; extra == "dev"
 Requires-Dist: vws-test-fixtures==2023.3.5; extra == "dev"
-Requires-Dist: vws-web-tools==2026.2.22.1; extra == "dev"
+Requires-Dist: vws-web-tools==2026.5.21; extra == "dev"
 Requires-Dist: yamlfix==1.19.1; extra == "dev"
-Requires-Dist: zizmor==1.24.1; extra == "dev"
+Requires-Dist: zizmor==1.28.0; extra == "dev"
 Provides-Extra: release
 Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
+Requires-Dist: towncrier==25.8.0; extra == "release"
 Dynamic: license-file
 
 |Build Status| |PyPI|
@@ -100,7 +104,7 @@ VWS Mock
 .. contents::
    :local:
 
-Mock for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
+Mock for the Vuforia Web Services (VWS) API, the Vuforia Web Query API, and the Model Target Web API.
 
 Mocking calls made to Vuforia
 ------------------------------

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/README.rst

@@ -6,7 +6,7 @@ VWS Mock
 .. contents::
    :local:
 
-Mock for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
+Mock for the Vuforia Web Services (VWS) API, the Vuforia Web Query API, and the Model Target Web API.
 
 Mocking calls made to Vuforia
 ------------------------------

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/admin/create_secrets_files.py

@@ -12,7 +12,11 @@ from pathlib import Path
 import vws_web_tools
 from selenium.common.exceptions import TimeoutException
 from selenium.webdriver.remote.webdriver import WebDriver
-from vws_web_tools import DatabaseDict, VuMarkDatabaseDict
+from vws_web_tools import (
+    DatabaseDict,
+    ModelTargetWebAPIDict,
+    VuMarkDatabaseDict,
+)
 
 VUMARK_TEMPLATE_SVG_FILE_PATH = Path(__file__).with_name(
     name="vumark_template.svg",
@@ -72,11 +76,13 @@ def _create_and_get_vumark_details(
 
 
 def _generate_secrets_file_content(
+    *,
     cloud_database_details: DatabaseDict,
     vumark_details: VuMarkDatabaseDict,
     inactive_database_details: DatabaseDict,
     inactive_vumark_details: VuMarkDatabaseDict,
     vumark_target_id: str,
+    model_target_web_api_details: ModelTargetWebAPIDict,
 ) -> str:
     """Generate the content of a secrets file."""
     return textwrap.dedent(
@@ -101,6 +107,10 @@ def _generate_secrets_file_content(
         INACTIVE_VUMARK_VUFORIA_TARGET_MANAGER_DATABASE_NAME={inactive_vumark_details["database_name"]}
         INACTIVE_VUMARK_VUFORIA_SERVER_ACCESS_KEY={inactive_vumark_details["server_access_key"]}
         INACTIVE_VUMARK_VUFORIA_SERVER_SECRET_KEY={inactive_vumark_details["server_secret_key"]}
+
+        MODEL_TARGET_VUFORIA_CLIENT_ID={model_target_web_api_details["client_id"]}
+        MODEL_TARGET_VUFORIA_CLIENT_SECRET={model_target_web_api_details["client_secret"]}
+        MODEL_TARGET_VUFORIA_CAD_DATA_URL={model_target_web_api_details["cad_data_url"]}
         """,
     )
 
@@ -193,6 +203,21 @@ def _create_and_get_inactive_vumark_details(
     return vumark_database_details
 
 
+def _get_model_target_web_api_details(
+    driver: WebDriver,
+    email_address: str,
+    password: str,
+) -> ModelTargetWebAPIDict:
+    """Get credentials and input data for the Model Target Web API."""
+    vws_web_tools.log_in(
+        driver=driver,
+        email_address=email_address,
+        password=password,
+    )
+    vws_web_tools.wait_for_logged_in(driver=driver)
+    return vws_web_tools.get_model_target_web_api_details(driver=driver)
+
+
 def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
     """Create names for Vuforia resources."""
     time = datetime.datetime.now(tz=datetime.UTC).strftime(
@@ -236,6 +261,14 @@ def main() -> None:
     )
     inactive_vumark_driver.quit()
 
+    model_target_driver = vws_web_tools.create_chrome_driver()
+    model_target_web_api_details = _get_model_target_web_api_details(
+        driver=model_target_driver,
+        email_address=email_address,
+        password=password,
+    )
+    model_target_driver.quit()
+
     num_databases = 100
     required_files = [
         (new_secrets_dir / f"vuforia_secrets_{i}.env")
@@ -291,6 +324,7 @@ def main() -> None:
             inactive_database_details=inactive_database_details,
             inactive_vumark_details=inactive_vumark_details,
             vumark_target_id=vumark_target_id,
+            model_target_web_api_details=model_target_web_api_details,
         )
         file.write_text(data=file_contents)
         sys.stdout.write(f"Created database {file.name}\n")

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/conftest.py

@@ -10,7 +10,7 @@ from sybil.parsers.rest import (
     PythonCodeBlockParser,
 )
 
-from tests.mock_vws.utils.retries import RETRY_EXCEPTIONS
+from tests.mock_vws.utils.retries import TRANSIENT_VWS_EXCEPTIONS
 
 pytest_collect_file = Sybil(
     parsers=[
@@ -29,4 +29,4 @@ def pytest_set_filtered_exceptions() -> tuple[type[Exception], ...]:
     This is for ``pytest-retry``.
     The configuration for retries is in ``pyproject.toml``.
     """
-    return RETRY_EXCEPTIONS
+    return TRANSIENT_VWS_EXCEPTIONS

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/docs/source/conf.py

@@ -24,10 +24,19 @@ extensions = [
     "sphinx_paramlinks",
     "sphinx_substitution_extensions",
     "sphinxcontrib.spelling",
+    "sphinxcontrib.towncrier.ext",
     "sphinxcontrib.autohttp.flask",
     "sphinx_toolbox.more_autodoc.autoprotocol",
 ]
 
+# Render the unreleased ``newsfragments/`` entries into
+# ``docs/source/unreleased.rst`` so the Sphinx spelling, doc-build and
+# link-checking gates cover the prose before it is assembled into
+# CHANGELOG.rst at release time.
+towncrier_draft_autoversion_mode = "draft"
+towncrier_draft_include_empty = True
+towncrier_draft_working_directory = f"{_pyproject_file.parent}"
+
 # Required by sphinx-toolbox 4.2.0rc1 for compatibility with Sphinx 9.
 # See https://github.com/sphinx-toolbox/sphinx-toolbox/issues/201#issuecomment-4313483053.
 autodoc_use_legacy_class_based = True

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/docs/source/differences-to-vws.rst

@@ -92,12 +92,31 @@ There are some result codes which the mock cannot return.
 These are:
 
 * ``DateRangeError``
-* ``ProjectHasNoAPIAccess``
-* ``ProjectSuspended``
-* ``RequestQuotaReached``
-* ``TargetQuotaReached``
 * ``TooManyRequests``
 
+Request quota exhaustion
+------------------------
+
+The mock returns ``RequestQuotaReached`` when a
+:class:`mock_vws.database.CloudDatabase` is created with
+``request_quota=0``. This behavior follows the public Vuforia documentation,
+but the response has not been verified against a real database with an
+exhausted quota.
+
+Other configurable result codes
+-------------------------------
+
+The mock also supports three other result codes which have not been verified
+against real databases in the corresponding states:
+
+* ``TargetQuotaReached`` is returned when adding a target to a
+  :class:`mock_vws.database.CloudDatabase` which already contains
+  ``target_quota`` targets.
+* ``ProjectSuspended`` is returned by VWS endpoints when a database uses the
+  :attr:`mock_vws.states.States.PROJECT_SUSPENDED` state.
+* ``ProjectHasNoAPIAccess`` is returned by VWS endpoints when a database uses
+  the :attr:`mock_vws.states.States.PROJECT_HAS_NO_API_ACCESS` state.
+
 ``Content-Length`` headers
 --------------------------
 
@@ -110,6 +129,21 @@ The mock returns a fixed minimal image in the requested format.
 The ``instance_id`` value is not encoded into the response image.
 Real Vuforia encodes the instance ID into the VuMark pattern.
 
+Model Target datasets
+---------------------
+
+The Model Target Web API mock supports OAuth2 token requests, standard and advanced dataset creation, status polling, dataset downloads, and deletion.
+The generated dataset download is a small valid zip file containing request metadata, not a real Vuforia Engine Model Target dataset.
+Model Target API routes require a syntactically JSON Web Token-shaped bearer token, such as the token returned by the mock OAuth2 route.
+The mock does not verify token signatures, claims, expiry, or revocation.
+
+For unknown Model Target datasets, the mock returns an error whose ``target`` is ``userId:mock``.
+Real Vuforia uses ``userId:<numeric-user-id>`` where the numeric portion is per-account.
+
+Two Model Target Web API error paths remain mock-only in ``tests/mock_vws/test_model_target_web_api.py::TestMockOnlyErrors``.
+Downloads of still-processing datasets are mock-only because exercising the path against real Vuforia would require creating a dataset on every test run; the mock drives the processing window deterministically.
+Advanced-dataset creation with more than 20 models is mock-only because the available test account lacks the advanced-dataset scope and real Vuforia rejects the request with a 403 before validating model counts.
+
 Header cases
 ------------
 

{vws_python_mock-2026.4.26 → vws_python_mock-2026.8.4}/docs/source/index.rst

@@ -40,6 +40,7 @@ Reference
 .. toctree::
    :hidden:
 
+   unreleased
    changelog
    release-process
    ci-setup