destiny_sdk 0.7.3__py3-none-any.whl → 0.7.4__py3-none-any.whl

destiny_sdk/enhancements.py

@@ -8,6 +8,7 @@ from typing import Annotated, Any, Literal, Self
 from pydantic import UUID4, BaseModel, Field, HttpUrl, model_validator
 
 from destiny_sdk.core import _JsonlFileInputMixIn
+from destiny_sdk.identifiers import Identifier
 from destiny_sdk.visibility import Visibility
 
 
@@ -26,6 +27,8 @@ class EnhancementType(StrEnum):
     """A free-form enhancement for tagging with labels."""
     LOCATION = auto()
     """Locations where the reference can be found."""
+    REFERENCE_ASSOCIATION = auto()
+    """Associations to other references."""
     RAW = auto()
     """A free form enhancement for arbitrary/unstructured data."""
     FULL_TEXT = auto()
@@ -56,7 +59,11 @@ class Authorship(BaseModel):
     for our purposes.
     """
 
-    display_name: str = Field(description="The display name of the author.")
+    display_name: str = Field(
+        description="The display name of the author. "
+        "Expected format FIRSTNAME <MIDDLENAME> LASTNAME. "
+        "Providing display_name in an unexpected format will affect search performance."
+    )
     orcid: str | None = Field(default=None, description="The ORCid of the author.")
     position: AuthorPosition = Field(
         description="The position of the author within the list of authors."
@@ -320,6 +327,43 @@ class LocationEnhancement(BaseModel):
     )
 
 
+class ReferenceAssociationType(StrEnum):
+    """
+    The type of association between references.
+
+    Direction is important: "this reference <association_type> associated reference".
+    """
+
+    CITES = auto()
+    """This reference cites the related reference."""
+    IS_CITED_BY = auto()
+    """This reference is cited by the related reference."""
+    IS_SIMILAR_TO = auto()
+    """This reference is similar to the related reference."""
+
+
+class ReferenceAssociationEnhancement(BaseModel):
+    """An enhancement for storing associations between references."""
+
+    enhancement_type: Literal[EnhancementType.REFERENCE_ASSOCIATION] = (
+        EnhancementType.REFERENCE_ASSOCIATION
+    )
+    associated_reference_ids: list[Identifier] = Field(
+        min_length=1,
+        description=(
+            "A list of Identifiers which are associated to this reference. "
+            "These can either be ExternalIdentifiers or resolved repository UUID4s."
+        ),
+    )
+    association_type: ReferenceAssociationType = Field(
+        description=(
+            "The type of association between this reference and the associated ones. "
+            "Direction is important: "
+            '"this reference <association_type> associated reference".'
+        )
+    )
+
+
 class RawEnhancement(BaseModel):
     """
     An enhancement for storing raw/arbitrary/unstructured data.
@@ -377,6 +421,7 @@ EnhancementContent = Annotated[
     | AbstractContentEnhancement
     | AnnotationEnhancement
     | LocationEnhancement
+    | ReferenceAssociationEnhancement
     | RawEnhancement,
     Field(discriminator="enhancement_type"),
 ]

destiny_sdk/identifiers.py

@@ -165,6 +165,9 @@ ExternalIdentifier = Annotated[
     Field(discriminator="identifier_type"),
 ]
 
+#: Any identifier including external identifiers and repository UUID4s.
+Identifier = Annotated[ExternalIdentifier | UUID4, Field()]
+
 ExternalIdentifierAdapter: TypeAdapter[ExternalIdentifier] = TypeAdapter(
     ExternalIdentifier
 )
@@ -245,7 +248,7 @@ class IdentifierLookup(BaseModel):
         )
 
     @classmethod
-    def from_identifier(cls, identifier: ExternalIdentifier | UUID4) -> Self:
+    def from_identifier(cls, identifier: Identifier) -> Self:
         """Create an IdentifierLookup from an ExternalIdentifier or UUID4."""
         if isinstance(identifier, uuid.UUID):
             return cls(identifier=str(identifier), identifier_type=None)
@@ -255,7 +258,7 @@ class IdentifierLookup(BaseModel):
             other_identifier_name=getattr(identifier, "other_identifier_name", None),
         )
 
-    def to_identifier(self) -> ExternalIdentifier | UUID4:
+    def to_identifier(self) -> Identifier:
         """Convert into an ExternalIdentifier or UUID4 if it has no identifier_type."""
         if self.identifier_type is None:
             return UUID4(self.identifier)

{destiny_sdk-0.7.3.dist-info → destiny_sdk-0.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: destiny_sdk
-Version: 0.7.3
+Version: 0.7.4
 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

{destiny_sdk-0.7.3.dist-info → destiny_sdk-0.7.4.dist-info}/RECORD

@@ -2,8 +2,8 @@ destiny_sdk/__init__.py,sha256=NdSlsPQyDF3TW30_JzbvYMRBRA9iT677iTRWWCMdYOA,382
 destiny_sdk/auth.py,sha256=bY72ywZEcG_67YBd9PrwgWTXkCf58rhLvVEXrtXbWtA,6247
 destiny_sdk/client.py,sha256=nKvS5rRkIpBqv8dVIB57Xsop0UvVz3i875RQxfVSMao,21306
 destiny_sdk/core.py,sha256=E0Wotu9psggK1JRJxbvx3Jc7WEGE6zaz2R2awvRrLz8,2023
-destiny_sdk/enhancements.py,sha256=P_kH59WoWuYq444xjV05HNXlTGfB-lE0ffKYwpAY7z8,14118
-destiny_sdk/identifiers.py,sha256=I9Q2I35Lg8oyl3uytq1gCGOUu92F9sZSSwzLoCXBJi4,9727
+destiny_sdk/enhancements.py,sha256=79-lXOowRPC3EdM3PZPkcbnVIj5Bnbp_GIlVuEYhLkM,15707
+destiny_sdk/identifiers.py,sha256=JoJvRBzK4pGTRB03mCaGPyjd32tqZLT5hnRgc9Yi95Q,9828
 destiny_sdk/imports.py,sha256=b-rh-dt3NsyLGxqmVzIzKaHiXhbw-3wtAaBN-ZW-i1E,5940
 destiny_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 destiny_sdk/references.py,sha256=3Y8gBMTSyZY35S3pB1bnVHMai9RRiGeoGZysNvSo7kk,2553
@@ -15,7 +15,7 @@ destiny_sdk/labs/references.py,sha256=iZisRgGZ5c7X7uTFoe6Q0AwwFMa4yJbIoPUVv_hvOi
 destiny_sdk/parsers/__init__.py,sha256=d5gS--bXla_0I7e_9wTBnGWMXt2U8b-_ndeprTPe1hk,149
 destiny_sdk/parsers/eppi_parser.py,sha256=_1xnAT0F0o1HKpMWOGQbVS3VPOrhPqyzHDWR3CosWwk,9484
 destiny_sdk/parsers/exceptions.py,sha256=0Sc_M4j560Nqh4SjeP_YrgOUVagdIwWwRz24E6YlZ1k,573
-destiny_sdk-0.7.3.dist-info/METADATA,sha256=2z_JjoZa-UMvOaPefJoYAc1ILx39gT0IWIqfYljbS1g,2685
-destiny_sdk-0.7.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-destiny_sdk-0.7.3.dist-info/licenses/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
-destiny_sdk-0.7.3.dist-info/RECORD,,
+destiny_sdk-0.7.4.dist-info/METADATA,sha256=Qb7_sEE2hy49aCE929t1SiSlHGZQXxeMLHPL_GCJp1k,2685
+destiny_sdk-0.7.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+destiny_sdk-0.7.4.dist-info/licenses/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
+destiny_sdk-0.7.4.dist-info/RECORD,,