vws-python 2026.8.26__tar.gz → 2026.10.9__tar.gz

{vws_python-2026.8.26 → vws_python-2026.10.9}/.github/workflows/autofix.yml

@@ -21,10 +21,10 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v10.0.1
+        uses: astral-sh/setup-uv@v10.2.0
 
       - name: Run fixers
-        uses: j178/prek-action@v3.0.0
+        uses: j178/prek-action@v3.0.1
         with:
           prek-version: 0.4.11
           extra-args: >-

{vws_python-2026.8.26 → vws_python-2026.10.9}/.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v10.0.1
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -37,12 +37,12 @@ jobs:
         run: |
           # We run tests against "." and not the tests directory as we test the README
           # and documentation.
-          uv run --extra=dev --python=${{ matrix.python-version }} pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests/ .
+          uv run --group=dev --python=${{ matrix.python-version }} pytest -s -vvv . --cov --cov-config=pyproject.toml
 
   completion-ci:
     needs: build
     runs-on: ubuntu-latest
-    if: always()  # Run even if one matrix job fails
+    if: ${{ !cancelled() }}  # Run even if one matrix job fails
     steps:
       - name: Check matrix job status
         run: |-

{vws_python-2026.8.26 → vws_python-2026.10.9}/.github/workflows/lint.yml

@@ -29,13 +29,13 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v10.0.1
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
 
       - name: Lint
-        uses: j178/prek-action@v3.0.0
+        uses: j178/prek-action@v3.0.1
         with:
           prek-version: 0.4.11
           cache: false
@@ -48,7 +48,7 @@ jobs:
   completion-lint:
     needs: build
     runs-on: ubuntu-latest
-    if: always()  # Run even if one matrix job fails
+    if: ${{ !cancelled() }}  # Run even if one matrix job fails
     steps:
       - name: Check matrix job status
         run: |-

{vws_python-2026.8.26 → vws_python-2026.10.9}/.github/workflows/publish-site.yml

@@ -21,7 +21,7 @@ jobs:
         uses: sphinx-notes/pages@v3
         with:
           documentation_path: docs/source
-          pyproject_extras: dev
+          pyproject_group: dev
           python_version: '3.14'
           sphinx_build_options: -W
           cache: true

{vws_python-2026.8.26 → vws_python-2026.10.9}/.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v10.0.1
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           enable-cache: true
           cache-dependency-glob: '**/pyproject.toml'
@@ -47,33 +47,24 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      # 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
+      - name: Assemble native Markdown release notes
         env:
           RELEASE: ${{ steps.calver.outputs.release }}
-        run: uv run --extra=release towncrier build --draft --version "$RELEASE" >
-          release-notes.md
-
-      # Assemble the same fragments into CHANGELOG.rst under a new
-      # ``$RELEASE`` section and delete the consumed fragment files.
-      - name: Update the changelog
-        env:
-          RELEASE: ${{ steps.calver.outputs.release }}
-        run: uv run --extra=release towncrier build --yes --version "$RELEASE"
+        run: |
+          uv run --group=release towncrier build --yes --version "$RELEASE"
+          cp "docs/source/changelog/$RELEASE.md" release-notes.md
 
       - uses: stefanzweifel/git-auto-commit-action@v7
         id: commit
         with:
           commit_message: Bump CHANGELOG
-          file_pattern: CHANGELOG.rst newsfragments
+          file_pattern: CHANGELOG.md docs/source/changelog newsfragments
           # Error if there are no changes.
           skip_dirty_check: true
 
       - name: Bump version and push tag
         id: tag_version
-        uses: mathieudutour/github-tag-action@v6.2
+        uses: mathieudutour/github-tag-action@v7
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           custom_tag: ${{ steps.calver.outputs.release }}
@@ -95,7 +86,7 @@ jobs:
           git fetch --tags
           git checkout "$NEW_TAG"
           uv build --sdist --wheel --out-dir dist/
-          uv run --extra=release check-wheel-contents dist/*.whl
+          uv run --group=release check-wheel-contents dist/*.whl
 
       - name: Publish distribution 📦 to PyPI
         # We use PyPI trusted publishing rather than a PyPI API token.

{vws_python-2026.8.26 → vws_python-2026.10.9}/.vale.ini

@@ -4,12 +4,12 @@ MinAlertLevel = error
 Packages = https://github.com/tbhb/vale-ai-tells/releases/download/v1.29.0/ai-tells.zip
 
 [*.{rst,md}]
-BasedOnStyles = ai-tells
+BasedOnStyles = ai-tells, snapper
+snapper.SemanticLineBreaks = error
 
 # These rules misclassify established technical, example, or release-note prose
 # in this repository. All other ai-tells rules remain enforced.
 ai-tells.ColonUsage = NO
-ai-tells.FigurativeLands = NO
 ai-tells.FormalTransitions = NO
 ai-tells.OverusedVocabularyVerbs = NO
 ai-tells.VerbTricolon = NO

vws_python-2026.10.9/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Release notes are stored as [one Markdown file per version](docs/source/changelog/).

{vws_python-2026.8.26 → vws_python-2026.10.9}/CODE_OF_CONDUCT.rst

@@ -11,19 +11,9 @@ 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
+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.
 
@@ -32,12 +22,17 @@ Project maintainers have the right and responsibility to remove, edit, or reject
 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.
+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.
+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.
 

vws_python-2026.10.9/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: vws-python
+Version: 2026.10.9
+Summary: Interact with the Vuforia Web Services (VWS) API.
+Author-email: Adam Dangoor <adamdangoor@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://vws-python.github.io/vws-python/
+Project-URL: Source, https://github.com/VWS-Python/vws-python
+Keywords: client,vuforia,vws
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: beartype>=0.22.9
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: httpx2>=2.12
+Requires-Dist: requests>=2.32.3
+Requires-Dist: urllib3>=2.2.3
+Requires-Dist: vws-auth-tools>=2024.7.12
+Dynamic: license-file
+
+|Build Status| |PyPI|
+
+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 |minimum-python-version|\+.
+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.github.io/vws-python/>`__.
+
+.. |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
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
+   :target: https://badge.fury.io/py/VWS-Python
+.. |minimum-python-version| replace:: 3.14

{vws_python-2026.8.26 → vws_python-2026.10.9}/README.rst

@@ -3,8 +3,7 @@
 vws-python
 ==========
 
-Python library for the Vuforia Web Services (VWS) API and the Vuforia
-Web Query API.
+Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
 
 Installation
 ------------
@@ -13,9 +12,8 @@ Installation
 
    pip install vws-python
 
-This is tested on Python |minimum-python-version|\+. Get in touch with
-``adamdangoor@gmail.com`` if you would like to use this with another
-language.
+This is tested on Python |minimum-python-version|\+.
+Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
 
 Getting Started
 ---------------

{vws_python-2026.8.26 → vws_python-2026.10.9}/conftest.py

@@ -1,10 +1,11 @@
 """Setup for Sybil."""
 
-import io  # noqa: TC003
+from __future__ import annotations
+
 import uuid
-from collections.abc import Generator  # noqa: TC003
 from doctest import ELLIPSIS
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import pytest
 from mock_vws import MockVWS
@@ -16,6 +17,10 @@ from sybil.parsers.rest import (
     PythonCodeBlockParser,
 )
 
+if TYPE_CHECKING:
+    import io
+    from collections.abc import Generator
+
 
 @pytest.fixture(name="make_image_file")
 def fixture_make_image_file(
@@ -28,7 +33,7 @@ def fixture_make_image_file(
     """
     new_image = Path("high_quality_image.jpg")
     buffer = high_quality_image.getvalue()
-    new_image.write_bytes(data=buffer)
+    _ = new_image.write_bytes(data=buffer)
     yield
     new_image.unlink()
 

{vws_python-2026.8.26 → vws_python-2026.10.9}/docs/source/api-reference.rst

@@ -33,6 +33,10 @@ API Reference
    :undoc-members:
    :members:
 
+.. automodule:: vws.json_types
+   :undoc-members:
+   :members:
+
 .. automodule:: vws.include_target_data
    :undoc-members:
    :members:

vws_python-2026.10.9/docs/source/changelog/2019.11.23.0.md

@@ -0,0 +1,3 @@
+# 2019.11.23.0
+
+- Make `active_flag` and `application_metadata` required on `add_target`.

vws_python-2026.10.9/docs/source/changelog/2020.03.21.0.md

@@ -0,0 +1,3 @@
+# 2020.03.21.0
+
+- Add Windows support.

vws_python-2026.10.9/docs/source/changelog/2020.06.19.0.md

@@ -0,0 +1 @@
+# 2020.06.19.0

vws_python-2026.10.9/docs/source/changelog/2020.08.21.0.md

@@ -0,0 +1,3 @@
+# 2020.08.21.0
+
+- Change the return type of `vws_client.get_target_record` to match what is returned by the web API.

vws_python-2026.10.9/docs/source/changelog/2020.09.07.0.md

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

vws_python-2026.10.9/docs/source/changelog/2021.03.28.0.md

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

vws_python-2026.10.9/docs/source/changelog/2021.03.28.1.md

@@ -0,0 +1 @@
+# 2021.03.28.1

vws_python-2026.10.9/docs/source/changelog/2021.03.28.2.md

@@ -0,0 +1 @@
+# 2021.03.28.2

vws_python-2026.10.9/docs/source/changelog/2023.03.05.md

@@ -0,0 +1 @@
+# 2023.03.05

vws_python-2026.10.9/docs/source/changelog/2023.03.25.md

@@ -0,0 +1,3 @@
+# 2023.03.25
+
+- Support file-like objects in every method which accepts a file.

vws_python-2026.10.9/docs/source/changelog/2023.05.21.md

@@ -0,0 +1,3 @@
+# 2023.05.21
+
+- Breaking change: the `vws.exceptions.custom_exceptions.ActiveMatchingTargetsDeleteProcessing` exception has been removed as Vuforia no longer returns this error.

vws_python-2026.10.9/docs/source/changelog/2023.12.26.md

@@ -0,0 +1 @@
+# 2023.12.26

vws_python-2026.10.9/docs/source/changelog/2023.12.27.md

@@ -0,0 +1,4 @@
+# 2023.12.27
+
+- Breaking change: The `vws.exceptions.cloud_reco_exceptions.UnknownVWSErrorPossiblyBadName` is now `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName`.
+- `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName` now has a `response` parameter and attribute.

vws_python-2026.10.9/docs/source/changelog/2024.02.04.1.md

@@ -0,0 +1 @@
+# 2024.02.04.1

vws_python-2026.10.9/docs/source/changelog/2024.02.04.md

@@ -0,0 +1,3 @@
+# 2024.02.04
+
+- Return a new error (`vws.custom_exceptions.ServerError`) when the server returns a 5xx status code.

vws_python-2026.10.9/docs/source/changelog/2024.02.06.md

@@ -0,0 +1,3 @@
+# 2024.02.06
+
+- Exception response attributes are now `vws.exceptions.response.Response` instances rather than `requests.Response` objects.

vws_python-2026.10.9/docs/source/changelog/2024.02.19.md

@@ -0,0 +1,3 @@
+# 2024.02.19
+
+- Add exception response attribute to `vws.exceptions.custom_exceptions.RequestEntityTooLarge`.

vws_python-2026.10.9/docs/source/changelog/2024.09.02.md

@@ -0,0 +1,5 @@
+# 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`.

vws_python-2026.10.9/docs/source/changelog/2024.09.03.md

@@ -0,0 +1,3 @@
+# 2024.09.03
+
+- Make `VWS.make_request` a public method.

vws_python-2026.10.9/docs/source/changelog/2024.09.04.1.md

@@ -0,0 +1 @@
+# 2024.09.04.1

vws_python-2026.10.9/docs/source/changelog/2024.09.04.md

@@ -0,0 +1,4 @@
+# 2024.09.04
+
+- Move `Response` from `vws.exceptions.response` to `vws.types`.
+- Add `raw` field to `Response`.

vws_python-2026.10.9/docs/source/changelog/2024.09.21.md

@@ -0,0 +1 @@
+# 2024.09.21

vws_python-2026.10.9/docs/source/changelog/2025.03.10.1.md

@@ -0,0 +1 @@
+# 2025.03.10.1

vws_python-2026.10.9/docs/source/changelog/2025.03.10.md

@@ -0,0 +1,3 @@
+# 2025.03.10
+
+- Removed `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName` which now does not occur in VWS.

vws_python-2026.10.9/docs/source/changelog/2026.02.15.md

@@ -0,0 +1,5 @@
+# 2026.02.15
+
+- Add `request_timeout_seconds` parameter to `VWS` and `CloudRecoService`, allowing customization of the request timeout.
+  This accepts a float or a `(connect, read)` tuple, matching the `requests` library's timeout interface.
+  The default remains 30 seconds.

vws_python-2026.10.9/docs/source/changelog/2026.02.21.md

@@ -0,0 +1 @@
+# 2026.02.21

vws_python-2026.10.9/docs/source/changelog/2026.02.22.md

@@ -0,0 +1 @@
+# 2026.02.22

vws_python-2026.10.9/docs/source/changelog/2026.02.23.md

@@ -0,0 +1 @@
+# 2026.02.23

vws_python-2026.10.9/docs/source/changelog/2026.02.24.md

@@ -0,0 +1 @@
+# 2026.02.24

vws_python-2026.10.9/docs/source/changelog/2026.02.25.1.md

@@ -0,0 +1 @@
+# 2026.02.25.1

vws_python-2026.10.9/docs/source/changelog/2026.02.25.md

@@ -0,0 +1 @@
+# 2026.02.25

vws_python-2026.10.9/docs/source/changelog/2026.08.14.md

@@ -0,0 +1,13 @@
+# 2026.08.14
+
+- Drop Python 3.13 support, update VWS Python Mock, and test quota and project-state error responses against the mock.
+- Add `QuotaExceededError`, `LicenseCheckFailedError`, and `AuthorizationFailedError` for documented VuMark Generation API result codes.
+- Fix `target_id` on target exceptions when `base_vws_url` includes a path prefix.
+- Retain explicitly provided falsy custom transports instead of replacing them with defaults.
+- Raise a response-carrying `CloudRecoError` when Cloud Query returns a documented empty or non-JSON 4xx response instead of leaking `JSONDecodeError`.
+- Add support for the Model Target Web API.
+  `ModelTargetService` and `AsyncModelTargetService` create standard and advanced Model Target datasets, wait for them to be generated, download them and delete them.
+- Map the `ProjectHasNoApiAccess` result code, as spelled in Vuforia's result codes table, to `ProjectHasNoAPIAccessError`.
+  The previously mapped `ProjectHasNoAPIAccess` casing, which Vuforia does not document, is no longer mapped.
+- Add support for the Database Reco Counts report.
+  `VWS` and `AsyncVWS` take an optional `database_id`, and have new `request_database_reco_counts_report`, `download_reco_counts_report` and `wait_for_reco_counts_report` methods.

vws_python-2026.10.9/docs/source/changelog/2026.08.26.md

@@ -0,0 +1,3 @@
+# 2026.08.26
+
+- Test synchronous and asynchronous Model Target error responses through the public mock API, and include rate-limit and server-error branches in coverage.

vws_python-2026.10.9/docs/source/changelog/2026.09.07.md

@@ -0,0 +1,5 @@
+# 2026.09.07
+
+- Add `HTTPX2Transport` and `AsyncHTTPX2Transport`, which make requests with `httpx2`, the continuation of `httpx` maintained by Pydantic.
+  The `requests` and `httpx` transports are unchanged.
+  `httpx` and `httpx2` objects are never mixed: the `httpx` transports raise `httpx` exceptions and the `httpx2` transports raise `httpx2` exceptions.

vws_python-2026.10.9/docs/source/changelog/2026.10.09.md

@@ -0,0 +1,10 @@
+# 2026.10.09 (2026-10-09)
+
+## Changes
+
+- Cover server errors from synchronous and asynchronous cloud recognition queries. ([#3214](https://github.com/VWS-Python/vws-python/issues/3214))
+- Model test credentials as pairs and name OAuth endpoint metadata precisely, avoiding secret false positives. ([#3215](https://github.com/VWS-Python/vws-python/issues/3215))
+- Remove supported inline type-checking comments by teaching Ruff about runtime-evaluated `beartype` annotations and postponing test annotations. ([#3216](https://github.com/VWS-Python/vws-python/issues/3216))
+- Validate query and Model Target report response values at construction time. ([#3218](https://github.com/VWS-Python/vws-python/issues/3218))
+- Type decoded report response dictionaries as JSON values. ([#3223](https://github.com/VWS-Python/vws-python/issues/3223))
+- Publish native Markdown release notes and use the same notes in documentation where available.

vws_python-2026.10.9/docs/source/changelog.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Releases are assembled from `newsfragments/` using Towncrier.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+:reversed:
+
+changelog/*
+```

{vws_python-2026.8.26 → vws_python-2026.10.9}/docs/source/conf.py

@@ -17,6 +17,7 @@ project = _pyproject_config.name
 author = _pyproject_config.author
 
 extensions = [
+    "myst_parser",
     "sphinx_copybutton",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
@@ -27,15 +28,15 @@ extensions = [
 ]
 
 # Render the unreleased ``newsfragments/`` entries into
-# ``docs/source/unreleased.rst`` so the Sphinx spelling, doc-build and
+# ``docs/source/unreleased.md`` so the Sphinx spelling, doc-build and
 # link-checking gates cover the prose before it is assembled into
-# CHANGELOG.rst at release time.
+# the versioned Markdown notes at release time.
 towncrier_draft_autoversion_mode = "draft"
 towncrier_draft_include_empty = True
 towncrier_draft_working_directory = f"{_pyproject_file.parent}"
 
 templates_path = ["_templates"]
-source_suffix = ".rst"
+source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
 master_doc = "index"
 
 project_copyright = f"%Y, {author}"

{vws_python-2026.8.26 → vws_python-2026.10.9}/docs/source/contributing.rst

@@ -12,7 +12,7 @@ Install Python dependencies in a virtual environment.
 
 .. code-block:: console
 
-   $ pip install --editable '.[dev]'
+   $ pip install --editable . --group dev
 
 Spell checking requires ``enchant``.
 This can be installed on macOS, for example, with `Homebrew`_:
@@ -64,7 +64,7 @@ Run the following commands to build and view documentation locally:
 
 .. code-block:: console
 
-   $ uv run --extra=dev sphinx-build -M html docs/source docs/build -W
+   $ uv run --group=dev sphinx-build -M html docs/source docs/build -W
    $ python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'
 
 Continuous integration
@@ -77,3 +77,10 @@ Performing a release
 --------------------
 
 See :doc:`release-process`.
+
+Release notes
+-------------
+
+Write user-facing changes as Markdown in ``newsfragments/<issue>.change.md``.
+Towncrier writes one Markdown file per version, used directly for GitHub release notes.
+Invalid fragment names fail release assembly.