destiny_sdk 0.8.0__tar.gz → 0.9.0__tar.gz

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.4
 Name: destiny_sdk
-Version: 0.8.0
+Version: 0.9.0
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 Author-email: Adam Hamilton <adam@futureevidence.org>, Andrew Harvey <andrew@futureevidence.org>, Daniel Breves <daniel@futureevidence.org>, Jack Walmisley <jack@futureevidence.org>, Tim Repke <tim.repke@pik-potsdam.de>
 License-Expression: Apache-2.0
 License-File: LICENSE
 Requires-Python: <4,>=3.12
 Requires-Dist: cachetools<6,>=5.5.2
-Requires-Dist: fastapi<0.116,>=0.115.12
+Requires-Dist: fastapi>=0.119.1
 Requires-Dist: httpx<0.29,>=0.28.1
 Requires-Dist: msal>=1.34.0
-Requires-Dist: pydantic<3,>=2.11.3
+Requires-Dist: pydantic<3,>=2.12.5
 Requires-Dist: python-jose<4,>=3.4.0
 Provides-Extra: labs
 Description-Content-Type: text/markdown

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/pyproject.toml

@@ -24,10 +24,10 @@ authors = [
 ]
 dependencies = [
     "cachetools>=5.5.2,<6",
-    "fastapi>=0.115.12,<0.116",
+    "fastapi>=0.119.1",
     "httpx>=0.28.1,<0.29",
     "msal>=1.34.0",
-    "pydantic>=2.11.3,<3",
+    "pydantic>=2.12.5,<3",
     "python-jose>=3.4.0,<4",
 ]
 description = "A software development kit (sdk) to support interaction with the DESTINY repository"
@@ -35,7 +35,7 @@ license = "Apache-2.0"
 name = "destiny_sdk"
 readme = "README.md"
 requires-python = ">=3.12, <4"
-version = "0.8.0"
+version = "0.9.0"
 
 [project.optional-dependencies]
 labs = []

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/__init__.py

@@ -11,8 +11,10 @@ from . import (
     search,
     visibility,
 )
+from .core import UUID
 
 __all__ = [
+    "UUID",
     "auth",
     "client",
     "enhancements",

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/auth.py

@@ -4,10 +4,11 @@ import hashlib
 import hmac
 import time
 from typing import Protocol, Self
-from uuid import UUID
 
 from fastapi import HTTPException, Request, status
-from pydantic import UUID4, BaseModel
+from pydantic import BaseModel, TypeAdapter
+
+from destiny_sdk.core import UUID
 
 FIVE_MINUTES = 60 * 5
 
@@ -29,7 +30,7 @@ class AuthException(HTTPException):
 
 
 def create_signature(
-    secret_key: str, request_body: bytes, client_id: UUID4, timestamp: float
+    secret_key: str, request_body: bytes, client_id: UUID, timestamp: float
 ) -> str:
     """
     Create an HMAC signature using SHA256.
@@ -39,7 +40,7 @@ def create_signature(
     :param request_body: request body to be encrypted
     :type request_body: bytes
     :param client_id: client id to include in hmac
-    :type: UUID4
+    :type: UUID
     :param timestamp: timestamp for when the request is sent
     :type: float
     :return: encrypted hexdigest of the request body with the secret key
@@ -64,7 +65,7 @@ class HMACAuthorizationHeaders(BaseModel):
     """
 
     signature: str
-    client_id: UUID4
+    client_id: UUID
     timestamp: float
 
     @classmethod
@@ -108,11 +109,11 @@ class HMACAuthorizationHeaders(BaseModel):
             )
 
         try:
-            UUID(client_id)
+            TypeAdapter(UUID).validate_python(client_id)
         except (ValueError, TypeError) as exc:
             raise AuthException(
                 status_code=status.HTTP_401_UNAUTHORIZED,
-                detail="Invalid format for client id, expected UUID4.",
+                detail="Invalid format for client id, expected UUIDv4 or UUIDv7.",
             ) from exc
 
         timestamp = request.headers.get("X-Request-Timestamp")

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/client.py

@@ -11,10 +11,10 @@ from msal import (
     PublicClientApplication,
     UserAssignedManagedIdentity,
 )
-from pydantic import UUID4, HttpUrl, TypeAdapter
+from pydantic import HttpUrl, TypeAdapter
 
 from destiny_sdk.auth import create_signature
-from destiny_sdk.core import sdk_version
+from destiny_sdk.core import UUID, sdk_version
 from destiny_sdk.identifiers import IdentifierLookup
 from destiny_sdk.references import Reference, ReferenceSearchResult
 from destiny_sdk.robots import (
@@ -35,7 +35,7 @@ class HMACSigningAuth(httpx.Auth):
 
     requires_request_body = True
 
-    def __init__(self, secret_key: str, client_id: UUID4) -> None:
+    def __init__(self, secret_key: str, client_id: UUID) -> None:
         """
         Initialize the client.
 
@@ -73,14 +73,16 @@ class RobotClient:
     Current implementation only supports robot results.
     """
 
-    def __init__(self, base_url: HttpUrl, secret_key: str, client_id: UUID4) -> None:
+    def __init__(self, base_url: HttpUrl, secret_key: str, client_id: UUID) -> None:
         """
         Initialize the client.
 
         :param base_url: The base URL for the Destiny Repository API.
         :type base_url: HttpUrl
         :param secret_key: The secret key for signing requests
-        :type auth_method: str
+        :type secret_key: str
+        :param client_id: The client ID for signing requests
+        :type client_id: UUID
         """
         self.session = httpx.Client(
             base_url=str(base_url).removesuffix("/").removesuffix("/v1") + "/v1",
@@ -131,7 +133,7 @@ class RobotClient:
 
     def poll_robot_enhancement_batch(
         self,
-        robot_id: UUID4,
+        robot_id: UUID,
         limit: int = 10,
         lease: str | None = None,
         timeout: int = 60,
@@ -142,7 +144,7 @@ class RobotClient:
         Signs the request with the client's secret key.
 
         :param robot_id: The ID of the robot to poll for
-        :type robot_id: UUID4
+        :type robot_id: UUID
         :param limit: The maximum number of pending enhancements to return
         :type limit: int
         :param lease: The duration to lease the pending enhancements for,
@@ -169,7 +171,7 @@ class RobotClient:
         return RobotEnhancementBatch.model_validate(response.json())
 
     def renew_robot_enhancement_batch_lease(
-        self, robot_enhancement_batch_id: UUID4, lease_duration: str | None = None
+        self, robot_enhancement_batch_id: UUID, lease_duration: str | None = None
     ) -> None:
         """
         Renew the lease for a robot enhancement batch.
@@ -177,7 +179,7 @@ class RobotClient:
         Signs the request with the client's secret key.
 
         :param robot_enhancement_batch_id: The ID of the robot enhancement batch
-        :type robot_enhancement_batch_id: UUID4
+        :type robot_enhancement_batch_id: UUID
         :param lease_duration: The duration to lease the pending enhancements for,
             in ISO 8601 duration format eg PT10M. If not provided the repository will
             use a default lease duration.

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/core.py

@@ -1,9 +1,9 @@
 """Core classes for the Destiny SDK, not exposed to package users."""
 
 from importlib.metadata import PackageNotFoundError, version
-from typing import Self
+from typing import Annotated, Self
 
-from pydantic import BaseModel, Field
+from pydantic import UUID4, UUID7, BaseModel, Field
 
 from destiny_sdk.search import SearchResultPage, SearchResultTotal
 
@@ -67,3 +67,9 @@ class SearchResultMixIn(BaseModel):
     page: SearchResultPage = Field(
         description="Information about the page of results.",
     )
+
+
+UUID = Annotated[
+    UUID4 | UUID7,
+    Field(description="A DESTINY UUID, which can be either UUID4 or UUID7."),
+]

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/enhancements.py

@@ -5,9 +5,9 @@ import json
 from enum import StrEnum, auto
 from typing import Annotated, Any, Literal, Self
 
-from pydantic import UUID4, BaseModel, Field, HttpUrl, field_validator, model_validator
+from pydantic import BaseModel, Field, HttpUrl, field_validator, model_validator
 
-from destiny_sdk.core import _JsonlFileInputMixIn
+from destiny_sdk.core import UUID, _JsonlFileInputMixIn
 from destiny_sdk.identifiers import Identifier
 from destiny_sdk.visibility import Visibility
 
@@ -524,7 +524,7 @@ EnhancementContent = Annotated[
 class Enhancement(_JsonlFileInputMixIn, BaseModel):
     """Core enhancement class."""
 
-    id: UUID4 | None = Field(
+    id: UUID | None = Field(
         default=None,
         description=(
             "The ID of the enhancement. "
@@ -532,7 +532,7 @@ class Enhancement(_JsonlFileInputMixIn, BaseModel):
         ),
     )
 
-    reference_id: UUID4 = Field(
+    reference_id: UUID = Field(
         description="The ID of the reference this enhancement is associated with."
     )
     source: str = Field(
@@ -545,7 +545,7 @@ class Enhancement(_JsonlFileInputMixIn, BaseModel):
         default=None,
         description="The version of the robot that generated the content.",
     )
-    derived_from: list[UUID4] | None = Field(
+    derived_from: list[UUID] | None = Field(
         default=None,
         description="List of enhancement IDs that this enhancement was derived from.",
     )

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/identifiers.py

@@ -6,7 +6,9 @@ import uuid
 from enum import StrEnum, auto
 from typing import Annotated, Literal, Self
 
-from pydantic import UUID4, BaseModel, Field, PositiveInt, TypeAdapter, field_validator
+from pydantic import BaseModel, Field, PositiveInt, TypeAdapter, field_validator
+
+from .core import UUID
 
 # Case-insensitive patterns for DOI URL prefix stripping
 _DOI_URL_PREFIX_RE = re.compile(r"^(?:https?://)?(?:dx\.)?doi\.org/", re.IGNORECASE)
@@ -205,7 +207,7 @@ ExternalIdentifier = Annotated[
 ]
 
 #: Any identifier including external identifiers and repository UUID4s.
-Identifier = Annotated[ExternalIdentifier | UUID4, Field()]
+Identifier = Annotated[ExternalIdentifier | UUID, Field()]
 
 ExternalIdentifierAdapter: TypeAdapter[ExternalIdentifier] = TypeAdapter(
     ExternalIdentifier
@@ -219,7 +221,7 @@ class LinkedExternalIdentifier(BaseModel):
         description="The identifier of the reference.",
         discriminator="identifier_type",
     )
-    reference_id: UUID4 = Field(
+    reference_id: UUID = Field(
         description="The ID of the reference this identifier identifies."
     )
 
@@ -250,11 +252,11 @@ class IdentifierLookup(BaseModel):
         """Parse an identifier string into an IdentifierLookup."""
         if delimiter not in identifier_lookup_string:
             try:
-                UUID4(identifier_lookup_string)
+                TypeAdapter(UUID).validate_python(identifier_lookup_string)
             except ValueError as exc:
                 msg = (
                     f"Invalid identifier lookup string: {identifier_lookup_string}. "
-                    "Must be UUIDv4 if no identifier type is specified."
+                    "Must be UUID if no identifier type is specified."
                 )
                 raise ValueError(msg) from exc
             return cls(
@@ -288,7 +290,9 @@ class IdentifierLookup(BaseModel):
 
     @classmethod
     def from_identifier(cls, identifier: Identifier) -> Self:
-        """Create an IdentifierLookup from an ExternalIdentifier or UUID4."""
+        """Create an IdentifierLookup from an ExternalIdentifier or UUID."""
+        # Use stdlib uuid here as we can't use Annotated types in isinstance checks
+        # The UUID versions is already validated per `identifier`
         if isinstance(identifier, uuid.UUID):
             return cls(identifier=str(identifier), identifier_type=None)
         return cls(
@@ -298,9 +302,9 @@ class IdentifierLookup(BaseModel):
         )
 
     def to_identifier(self) -> Identifier:
-        """Convert into an ExternalIdentifier or UUID4 if it has no identifier_type."""
+        """Convert into an ExternalIdentifier or UUID if it has no identifier_type."""
         if self.identifier_type is None:
-            return UUID4(self.identifier)
+            return TypeAdapter(UUID).validate_python(self.identifier)
         return ExternalIdentifierAdapter.validate_python(self.model_dump())
 
     def __repr__(self) -> str:

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/imports.py

@@ -4,13 +4,14 @@ import datetime
 from enum import StrEnum, auto
 
 from pydantic import (
-    UUID4,
     BaseModel,
     Field,
     HttpUrl,
     PastDatetime,
 )
 
+from .core import UUID
+
 
 class ImportRecordStatus(StrEnum):
     """Describes the status of an import record."""
@@ -108,7 +109,7 @@ class ImportRecordIn(_ImportRecordBase):
 class ImportRecordRead(_ImportRecordBase):
     """Core import record class."""
 
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="The ID of the import record",
     )
     status: ImportRecordStatus = Field(
@@ -140,13 +141,13 @@ class ImportBatchIn(_ImportBatchBase):
 class ImportBatchRead(_ImportBatchBase):
     """Core import batch class."""
 
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="The ID of the import batch",
     )
     status: ImportBatchStatus = Field(
         default=ImportBatchStatus.CREATED, description="The status of the batch."
     )
-    import_record_id: UUID4 = Field(
+    import_record_id: UUID = Field(
         description="The ID of the import record this batch is associated with"
     )
     import_record: ImportRecordRead | None = Field(
@@ -160,13 +161,13 @@ class ImportBatchRead(_ImportBatchBase):
 class ImportBatchSummary(_ImportBatchBase):
     """A view for an import batch that includes a summary of its results."""
 
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="""
 The identifier of the batch.
 """,
     )
 
-    import_batch_id: UUID4 = Field(description="The ID of the batch being summarised")
+    import_batch_id: UUID = Field(description="The ID of the batch being summarised")
 
     import_batch_status: ImportBatchStatus = Field(
         description="The status of the batch being summarised"
@@ -187,8 +188,8 @@ The identifier of the batch.
 class ImportResultRead(BaseModel):
     """Core import result class."""
 
-    id: UUID4 = Field(description="The ID of the import result.")
-    reference_id: UUID4 | None = Field(
+    id: UUID = Field(description="The ID of the import result.")
+    reference_id: UUID | None = Field(
         default=None,
         description="The ID of the reference created by this import result.",
     )

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/references.py

@@ -2,9 +2,9 @@
 
 from typing import Self
 
-from pydantic import UUID4, BaseModel, Field, TypeAdapter
+from pydantic import BaseModel, Field, TypeAdapter
 
-from destiny_sdk.core import SearchResultMixIn, _JsonlFileInputMixIn
+from destiny_sdk.core import UUID, SearchResultMixIn, _JsonlFileInputMixIn
 from destiny_sdk.enhancements import Enhancement, EnhancementFileInput
 from destiny_sdk.identifiers import ExternalIdentifier
 from destiny_sdk.visibility import Visibility
@@ -19,7 +19,7 @@ class Reference(_JsonlFileInputMixIn, BaseModel):
         default=Visibility.PUBLIC,
         description="The level of visibility of the reference",
     )
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="The ID of the reference",
     )
     identifiers: list[ExternalIdentifier] | None = Field(

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/src/destiny_sdk/robots.py

@@ -3,9 +3,9 @@
 from enum import StrEnum, auto
 from typing import Annotated, Any
 
-from pydantic import UUID4, BaseModel, ConfigDict, Field, HttpUrl
+from pydantic import BaseModel, ConfigDict, Field, HttpUrl
 
-from destiny_sdk.core import _JsonlFileInputMixIn
+from destiny_sdk.core import UUID, _JsonlFileInputMixIn
 from destiny_sdk.enhancements import Enhancement
 
 
@@ -30,7 +30,7 @@ class LinkedRobotError(_JsonlFileInputMixIn, RobotError):
     id is derived from the request id.
     """
 
-    reference_id: UUID4 = Field(
+    reference_id: UUID = Field(
         description="The ID of the reference which caused the error."
     )
 
@@ -38,7 +38,7 @@ class LinkedRobotError(_JsonlFileInputMixIn, RobotError):
 class RobotResult(BaseModel):
     """Used to indicate to the repository that the robot has finished processing."""
 
-    request_id: UUID4
+    request_id: UUID
     error: RobotError | None = Field(
         default=None,
         description="""
@@ -55,7 +55,7 @@ None, the repository will assume that the result file is ready for processing.
 class RobotEnhancementBatchResult(BaseModel):
     """Used to indicate that the robot has finished processing a batch."""
 
-    request_id: UUID4
+    request_id: UUID
     error: RobotError | None = Field(
         default=None,
         description="""
@@ -72,7 +72,7 @@ None, the repository will assume that the result file is ready for processing.
 class RobotResultValidationEntry(_JsonlFileInputMixIn, BaseModel):
     """A single entry in the validation result file for a batch enhancement request."""
 
-    reference_id: UUID4 | None = Field(
+    reference_id: UUID | None = Field(
         default=None,
         description=(
             "The ID of the reference which was enhanced. "
@@ -99,7 +99,7 @@ EnhancementResultEntry = Annotated[
 class RobotRequest(BaseModel):
     """A batch enhancement request from the repo to a robot."""
 
-    id: UUID4
+    id: UUID
     reference_storage_url: HttpUrl = Field(
         description="""
 The URL at which the set of references are stored. The file is a jsonl
@@ -130,7 +130,7 @@ If the URL expires, a new one can be generated using
 class RobotEnhancementBatch(BaseModel):
     """A robot enhancement batch from the repo to a robot."""
 
-    id: UUID4
+    id: UUID
     reference_storage_url: HttpUrl = Field(
         description="""
 The URL at which the set of references are stored. The file is a jsonl
@@ -190,10 +190,10 @@ class _EnhancementRequestBase(BaseModel):
     A enhancement request is a request to create one or more enhancements.
     """
 
-    robot_id: UUID4 = Field(
+    robot_id: UUID = Field(
         description="The robot to be used to create the enhancements."
     )
-    reference_ids: list[UUID4] = Field(
+    reference_ids: list[UUID] = Field(
         description="The IDs of the references to be enhanced."
     )
     source: str | None = Field(
@@ -209,7 +209,7 @@ class EnhancementRequestIn(_EnhancementRequestBase):
 class EnhancementRequestRead(_EnhancementRequestBase):
     """Core batch enhancement request class."""
 
-    id: UUID4
+    id: UUID
     request_status: EnhancementRequestStatus = Field(
         description="The status of the request to create enhancements",
     )
@@ -264,7 +264,7 @@ class _RobotEnhancementBatchBase(BaseModel):
     for processing.
     """
 
-    robot_id: UUID4 = Field(
+    robot_id: UUID = Field(
         description="The robot to be used to create the enhancements."
     )
     source: str | None = Field(
@@ -276,7 +276,7 @@ class _RobotEnhancementBatchBase(BaseModel):
 class RobotEnhancementBatchRead(_RobotEnhancementBatchBase):
     """Core robot enhancement batch class."""
 
-    id: UUID4
+    id: UUID
     reference_data_url: HttpUrl | None = Field(
         default=None,
         description="""
@@ -343,7 +343,7 @@ class RobotIn(_RobotBase):
 class Robot(_RobotBase):
     """Then model for a registered robot."""
 
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="The id of the robot provided by destiny repository. "
         "Used as the client_id when sending HMAC authenticated requests."
     )
@@ -366,7 +366,7 @@ class ProvisionedRobot(Robot):
 class _RobotAutomationBase(BaseModel):
     """Base Robot Automation class."""
 
-    robot_id: UUID4 = Field(
+    robot_id: UUID = Field(
         description="The ID of the robot that will be used to enhance the reference."
     )
     query: dict[str, Any] = Field(
@@ -394,6 +394,6 @@ class RobotAutomation(_RobotAutomationBase):
     is sent to the specified robot to perform the enhancement.
     """
 
-    id: UUID4 = Field(
+    id: UUID = Field(
         description="The ID of the robot automation.",
     )

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/tests/unit/test_auth.py

@@ -1,8 +1,8 @@
 """Tests for HMAC Authentication."""
 
 import time
-import uuid
 from collections.abc import AsyncGenerator
+from uuid import uuid7
 
 import destiny_sdk
 import pytest
@@ -11,7 +11,7 @@ from fastapi import APIRouter, Depends, FastAPI, status
 from httpx import ASGITransport, AsyncClient
 
 TEST_SECRET_KEY = "dlfskdfhgk8ei346oiehslkdfrerikfglser934utofs"
-TEST_CLIENT_ID = uuid.uuid4()
+TEST_CLIENT_ID = uuid7()
 REQUEST_BODY = b'{"message": "info"}'
 
 

{destiny_sdk-0.8.0 → destiny_sdk-0.9.0}/tests/unit/test_client.py

@@ -1,7 +1,7 @@
 """Tests client authentication"""
 
 import time
-import uuid
+from uuid import UUID, uuid7
 
 import httpx
 import pytest
@@ -43,7 +43,7 @@ def base_url():
 
 @pytest.fixture
 def test_reference_id():
-    return uuid.uuid4()
+    return uuid7()
 
 
 @pytest.fixture
@@ -66,19 +66,19 @@ class TestRobotClient:
     ) -> None:
         """Test that robot enhancement batch result request is authorized."""
         fake_secret_key = "asdfhjgji94523q0uflsjf349wjilsfjd9q23"
-        fake_robot_id = uuid.uuid4()
+        fake_robot_id = uuid7()
         fake_destiny_repository_url = (
             "https://www.destiny-repository-lives-here.co.au/v1"
         )
 
         fake_batch_result = RobotEnhancementBatchResult(
-            request_id=uuid.uuid4(),
+            request_id=uuid7(),
             error=RobotError(message="Cannot process this batch"),
         )
 
         expected_response_body = RobotEnhancementBatchRead(
-            id=uuid.uuid4(),
-            robot_id=uuid.uuid4(),
+            id=uuid7(),
+            robot_id=uuid7(),
             error="Cannot process this batch",
         )
 
@@ -126,7 +126,7 @@ class TestOAuthClient:
         httpx_mock: HTTPXMock,
         oauth_client: OAuthClient,
         base_url: str,
-        test_reference_id: uuid.UUID,
+        test_reference_id: UUID,
         mock_reference_response: dict,
     ) -> None:
         """Test that search works without authentication."""
@@ -199,7 +199,7 @@ class TestOAuthClient:
         httpx_mock: HTTPXMock,
         oauth_client: OAuthClient,
         base_url: str,
-        test_reference_id: uuid.UUID,
+        test_reference_id: UUID,
     ) -> None:
         """Test lookup references by identifiers."""
         httpx_mock.add_response(