destiny_sdk 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

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/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/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."
@@ -233,6 +237,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 +343,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."
+    )

{destiny_sdk-0.1.0.dist-info → destiny_sdk-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: destiny_sdk
-Version: 0.1.0
+Version: 0.1.1
 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.dist-info → destiny_sdk-0.1.1.dist-info}/RECORD

@@ -2,14 +2,14 @@ destiny_sdk/__init__.py,sha256=gmmrceJX84T4msk_GSm_OjTQvCpHFZRjnlUK5_7IODE,356
 destiny_sdk/auth.py,sha256=bY72ywZEcG_67YBd9PrwgWTXkCf58rhLvVEXrtXbWtA,6247
 destiny_sdk/client.py,sha256=gUZJ8Mnmm1mUH7zd8fJbTksgPzBQQoYOFcuzJGiO2Dk,3642
 destiny_sdk/core.py,sha256=GgNc7EncHKyZ5ppIG2CATWN2JFPjtA7IYhF0FutqwGE,945
-destiny_sdk/enhancements.py,sha256=fV3ybz9SLxOn9S0FRXjYeDySq0zNux-ipla8NwhGb8Y,11452
+destiny_sdk/enhancements.py,sha256=wFaphXYEHEU6yRijsP4tBY7BC6V9O2MPnOisfvE5EfE,11529
 destiny_sdk/identifiers.py,sha256=JHxu-wM3T8kKtAYuk5dMec35Ay73KxYP7gthbSvOhuI,3480
-destiny_sdk/imports.py,sha256=WdgGvl74BjwDNQ7LCqSEs7ZRMUtDNu0hkohGROVZHR0,7924
+destiny_sdk/imports.py,sha256=mfC1QXbAU27iD3hO9OFTRQes352F6DS1U4fSMw26-8w,8243
 destiny_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 destiny_sdk/references.py,sha256=Tt9sVgw6WIXIhXGrlgGdRgIrIgQL0yr3Aqb0nr0WfK0,1493
-destiny_sdk/robots.py,sha256=1xZajI5wm3xnIK5emH74KFUCCRqgnXAvFlA4tAlVmUg,11134
+destiny_sdk/robots.py,sha256=B38KYXz_YJkZZ5RKBt17sh8yPD88dNCJvISw7V4km5k,12490
 destiny_sdk/visibility.py,sha256=nDLqnWuSZSk0vG3ynzDpHAvaALsbk8cuEZujTsqf6no,684
-destiny_sdk-0.1.0.dist-info/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
-destiny_sdk-0.1.0.dist-info/METADATA,sha256=wiWa8b0VXOPXplK_VZdIxAUWWcyBAyHk5Owp3qFj-3c,2196
-destiny_sdk-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-destiny_sdk-0.1.0.dist-info/RECORD,,
+destiny_sdk-0.1.1.dist-info/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
+destiny_sdk-0.1.1.dist-info/METADATA,sha256=A4yKwHYOWseLSeHCVT8VoJ45ZC9w9EyX3R_WtU9M9Bo,2543
+destiny_sdk-0.1.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+destiny_sdk-0.1.1.dist-info/RECORD,,

{destiny_sdk-0.1.0.dist-info → destiny_sdk-0.1.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.3
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any