destiny_sdk 0.1.2__tar.gz → 0.1.3__tar.gz

{destiny_sdk-0.1.2 → destiny_sdk-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: destiny_sdk
-Version: 0.1.2
+Version: 0.1.3
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 License: Apache 2.0
 Author: Adam Hamilton

{destiny_sdk-0.1.2 → destiny_sdk-0.1.3}/pyproject.toml

@@ -13,7 +13,7 @@ description = "A software development kit (sdk) to support interaction with the
 license = "Apache 2.0"
 name = "destiny_sdk"
 readme = "README.md"
-version = "0.1.2"
+version = "0.1.3"
 
 [tool.poetry.dependencies]
 cachetools = "^5.5.2"
@@ -28,6 +28,7 @@ python-jose = "^3.4.0"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.15.0"
+pre-commit = "^4.2.0"
 pytest-env = "^1.1.5"
 ruff = "^0.11.5"
 uvloop = "^0.21.0"

{destiny_sdk-0.1.2 → destiny_sdk-0.1.3}/src/destiny_sdk/enhancements.py

@@ -1,11 +1,10 @@
 """Enhancement classes for the Destiny Repository."""
 
 import datetime
-import uuid
 from enum import StrEnum, auto
 from typing import Annotated, Literal
 
-from pydantic import BaseModel, Field, HttpUrl
+from pydantic import UUID4, BaseModel, Field, HttpUrl
 
 from destiny_sdk.core import _JsonlFileInputMixIn
 from destiny_sdk.visibility import Visibility
@@ -317,7 +316,15 @@ EnhancementContent = Annotated[
 class Enhancement(_JsonlFileInputMixIn, BaseModel):
     """Core enhancement class."""
 
-    reference_id: uuid.UUID = Field(
+    id: UUID4 | None = Field(
+        default=None,
+        description=(
+            "The ID of the enhancement. "
+            "Populated by the repository when sending enhancements with references."
+        ),
+    )
+
+    reference_id: UUID4 = Field(
         description="The ID of the reference this enhancement is associated with."
     )
     source: str = Field(
@@ -330,7 +337,7 @@ class Enhancement(_JsonlFileInputMixIn, BaseModel):
         default=None,
         description="The version of the robot that generated the content.",
     )
-    derived_from: list[uuid.UUID] | None = Field(
+    derived_from: list[UUID4] | None = Field(
         default=None,
         description="List of enhancement IDs that this enhancement was derived from.",
     )

{destiny_sdk-0.1.2 → destiny_sdk-0.1.3}/src/destiny_sdk/references.py

@@ -1,16 +1,12 @@
 """Reference classes for the Destiny SDK."""
 
-from typing import Self
-
-from pydantic import UUID4, BaseModel, Field, TypeAdapter
+from pydantic import UUID4, BaseModel, Field
 
 from destiny_sdk.core import _JsonlFileInputMixIn
 from destiny_sdk.enhancements import Enhancement, EnhancementFileInput
 from destiny_sdk.identifiers import ExternalIdentifier
 from destiny_sdk.visibility import Visibility
 
-external_identifier_adapter = TypeAdapter(ExternalIdentifier)
-
 
 class Reference(_JsonlFileInputMixIn, BaseModel):
     """Core reference class."""
@@ -31,24 +27,6 @@ class Reference(_JsonlFileInputMixIn, BaseModel):
         description="A list of enhancements for the reference",
     )
 
-    @classmethod
-    def from_es(cls, es_reference: dict) -> Self:
-        """Create a Reference from an Elasticsearch document."""
-        return cls(
-            id=es_reference["_id"],
-            visibility=Visibility(es_reference["_source"]["visibility"]),
-            identifiers=[
-                external_identifier_adapter.validate_python(identifier)
-                for identifier in es_reference["_source"].get("identifiers", [])
-            ],
-            enhancements=[
-                Enhancement.model_validate(
-                    enhancement | {"reference_id": es_reference["_id"]},
-                )
-                for enhancement in es_reference["_source"].get("enhancements", [])
-            ],
-        )
-
 
 class ReferenceFileInput(_JsonlFileInputMixIn, BaseModel):
     """Enhancement model used to marshall a file input."""

{destiny_sdk-0.1.2 → destiny_sdk-0.1.3}/src/destiny_sdk/robots.py

@@ -98,10 +98,15 @@ class RobotRequest(BaseModel):
     """An enhancement request from the repo to a robot."""
 
     id: UUID4
-    reference: Reference  # Reference with selected enhancements
-    extra_fields: (
-        dict | None
-    )  # We need something to pass through the signed url for uploads
+    reference: Reference = Field(
+        description=(
+            "Reference to be enhanced, includes identifiers and existing enhancments."
+        )
+    )
+    extra_fields: dict | None = Field(
+        default=None,
+        description="Extra fields to pass to the robot. TBC.",
+    )
 
 
 #: The result for a single reference when processed by a batch enhancement request.