destiny_sdk 0.1.0__tar.gz → 0.1.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: destiny_sdk
-Version: 0.1.0
+Version: 0.1.2
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 License: Apache 2.0
 Author: Adam Hamilton
@@ -90,3 +90,13 @@ poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
 poetry publish
 ```
 
+### Versioning
+
+Follow the [semver](https://semver.org/) guidelines for versioning, tldr;
+
+Given a version number `MAJOR.MINOR.PATCH`, increment the:
+
+- `MAJOR` version when you make incompatible API change
+- `MINOR` version when you add functionality in a backward compatible manner
+- `PATCH` version when you make backward compatible bug fixes
+

{destiny_sdk-0.1.0 → destiny_sdk-0.1.2}/README.md

@@ -67,3 +67,13 @@ poetry publish --repository testpypi
 poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
 poetry publish
 ```
+
+### Versioning
+
+Follow the [semver](https://semver.org/) guidelines for versioning, tldr;
+
+Given a version number `MAJOR.MINOR.PATCH`, increment the:
+
+- `MAJOR` version when you make incompatible API change
+- `MINOR` version when you add functionality in a backward compatible manner
+- `PATCH` version when you make backward compatible bug fixes

{destiny_sdk-0.1.0 → destiny_sdk-0.1.2}/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.0"
+version = "0.1.2"
 
 [tool.poetry.dependencies]
 cachetools = "^5.5.2"

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

@@ -1,10 +1,11 @@
 """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, PastDate
+from pydantic import BaseModel, Field, HttpUrl
 
 from destiny_sdk.core import _JsonlFileInputMixIn
 from destiny_sdk.visibility import Visibility
@@ -86,10 +87,10 @@ class BibliographicMetadataEnhancement(BaseModel):
 other works have cited this work
 """,
     )
-    created_date: PastDate | None = Field(
+    created_date: datetime.date | None = Field(
         default=None, description="The ISO8601 date this metadata record was created"
     )
-    publication_date: PastDate | None = Field(
+    publication_date: datetime.date | None = Field(
         default=None, description="The date which the version of record was published."
     )
     publication_year: int | None = Field(
@@ -172,10 +173,11 @@ class ScoreAnnotation(BaseModel):
     )
     score: float = Field(description="""Score for this annotation""")
     data: dict = Field(
+        default_factory=dict,
         description=(
             "An object representation of the annotation including any confidence scores"
             " or descriptions."
-        )
+        ),
     )
 
 
@@ -200,6 +202,7 @@ class BooleanAnnotation(BaseModel):
         None, description="A confidence score for this annotation"
     )
     data: dict = Field(
+        default_factory=dict,
         description="""
 An object representation of the annotation including any confidence scores or
 descriptions.

{destiny_sdk-0.1.0 → destiny_sdk-0.1.2}/src/destiny_sdk/imports.py

@@ -34,13 +34,20 @@ class ImportBatchStatus(StrEnum):
 
     - `created`: Created, but no processing has started.
     - `started`: Processing has started on the batch.
+    - `failed`: Processing has failed.
+    - `retrying`: Processing has failed, but is being retried.
+    - `indexing`: The imports have been saved and are being indexed.
+    - `indexing_failed`: The imports have been saved but were not indexed.
     - `completed`: Processing has been completed.
     - `cancelled`: Processing was cancelled by calling the API.
     """
 
     CREATED = auto()
     STARTED = auto()
+    RETRYING = auto()
     FAILED = auto()
+    INDEXING = auto()
+    INDEXING_FAILED = auto()
     COMPLETED = auto()
     CANCELLED = auto()
 

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

@@ -1,12 +1,16 @@
 """Reference classes for the Destiny SDK."""
 
-from pydantic import UUID4, BaseModel, Field
+from typing import Self
+
+from pydantic import UUID4, BaseModel, Field, TypeAdapter
 
 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."""
@@ -27,6 +31,24 @@ 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.0 → destiny_sdk-0.1.2}/src/destiny_sdk/robots.py

@@ -1,7 +1,7 @@
 """Schemas that define inputs/outputs for robots."""
 
 from enum import StrEnum, auto
-from typing import Annotated, Self
+from typing import Annotated, Any, Self
 
 from pydantic import UUID4, BaseModel, ConfigDict, Field, HttpUrl, model_validator
 
@@ -174,6 +174,10 @@ class _EnhancementRequestBase(BaseModel):
     robot_id: UUID4 = Field(
         description="The robot to be used to create the enhancement."
     )
+    source: str | None = Field(
+        default=None,
+        description="The source of the batch enhancement request.",
+    )
 
     enhancement_parameters: dict | None = Field(
         default=None, description="Information needed to create the enhancement. TBC."
@@ -208,6 +212,8 @@ class BatchEnhancementRequestStatus(StrEnum):
     - `partial_failed`: Some enhancements failed to create.
     - `failed`: All enhancements failed to create.
     - `importing`: Enhancements have been received by the repo and are being imported.
+    - `indexing`: Enhancements have been imported and are being indexed.
+    - `indexing_failed`: Enhancements have been imported but indexing failed.
     - `completed`: All enhancements have been created.
     """
 
@@ -217,6 +223,8 @@ class BatchEnhancementRequestStatus(StrEnum):
     PARTIAL_FAILED = auto()
     FAILED = auto()
     IMPORTING = auto()
+    INDEXING = auto()
+    INDEXING_FAILED = auto()
     COMPLETED = auto()
 
 
@@ -233,6 +241,10 @@ class _BatchEnhancementRequestBase(BaseModel):
     reference_ids: list[UUID4] = Field(
         description="The IDs of the references to be enhanced."
     )
+    source: str | None = Field(
+        default=None,
+        description="The source of the batch enhancement request.",
+    )
 
 
 class BatchEnhancementRequestIn(_BatchEnhancementRequestBase):
@@ -335,3 +347,39 @@ class ProvisionedRobot(Robot):
         description="The client secret of the robot, used as the secret key "
         "when sending HMAC authenticated requests."
     )
+
+
+class _RobotAutomationBase(BaseModel):
+    """Base Robot Automation class."""
+
+    query: dict[str, Any] = Field(
+        description="The percolator query that will be used to match references "
+        " or enhancements against."
+    )
+
+
+class RobotAutomationIn(_RobotAutomationBase):
+    """
+    Automation model for a robot.
+
+    This is used as a source of truth for an Elasticsearch index that percolates
+    references or enhancements against the queries. If a query matches, a request
+    is sent to the specified robot to perform the enhancement.
+    """
+
+
+class RobotAutomation(_RobotAutomationBase):
+    """
+    Core Robot Automation class.
+
+    This is used as a source of truth for an Elasticsearch index that percolates
+    references or enhancements against the queries. If a query matches, a request
+    is sent to the specified robot to perform the enhancement.
+    """
+
+    id: UUID4 = Field(
+        description="The ID of the robot automation.",
+    )
+    robot_id: UUID4 = Field(
+        description="The ID of the robot that will be used to enhance the reference."
+    )