destiny_sdk 0.1.3__tar.gz → 0.1.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: destiny_sdk
-Version: 0.1.3
+Version: 0.1.5
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 License: Apache 2.0
 Author: Adam Hamilton
@@ -75,20 +75,9 @@ poetry build
 poetry add ./PATH/TO/WHEEL.whl
 ```
 
-### Publishing to test pypi
+### Publishing
 
-```sh
-poetry config repositories.testpypi https://test.pypi.org/legacy/
-poetry config pypi-token.testpypi [YOUR_TESTPYPI_TOKEN]
-poetry publish --repository testpypi
-```
-
-## Publishing
-
-```sh
-poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
-poetry publish
-```
+Once the package change is merged to main with an iterated `libs/sdk/pyproject.toml` version number, you can run the [github action](https://github.com/destiny-evidence/destiny-repository/actions/workflows/release-sdk-to-pypi.yml) to publish to the test pypi and then production pypi registries.
 
 ### Versioning
 

{destiny_sdk-0.1.3 → destiny_sdk-0.1.5}/README.md

@@ -53,20 +53,9 @@ poetry build
 poetry add ./PATH/TO/WHEEL.whl
 ```
 
-### Publishing to test pypi
+### Publishing
 
-```sh
-poetry config repositories.testpypi https://test.pypi.org/legacy/
-poetry config pypi-token.testpypi [YOUR_TESTPYPI_TOKEN]
-poetry publish --repository testpypi
-```
-
-## Publishing
-
-```sh
-poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
-poetry publish
-```
+Once the package change is merged to main with an iterated `libs/sdk/pyproject.toml` version number, you can run the [github action](https://github.com/destiny-evidence/destiny-repository/actions/workflows/release-sdk-to-pypi.yml) to publish to the test pypi and then production pypi registries.
 
 ### Versioning
 

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

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

@@ -219,7 +219,7 @@ class AnnotationEnhancement(BaseModel):
     """An enhancement which is composed of a list of Annotations."""
 
     enhancement_type: Literal[EnhancementType.ANNOTATION] = EnhancementType.ANNOTATION
-    annotations: list[Annotation]
+    annotations: list[Annotation] = Field(min_length=1)
 
 
 class DriverVersion(StrEnum):
@@ -299,7 +299,8 @@ class LocationEnhancement(BaseModel):
 
     enhancement_type: Literal[EnhancementType.LOCATION] = EnhancementType.LOCATION
     locations: list[Location] = Field(
-        description="A list of locations where this reference can be found."
+        min_length=1,
+        description="A list of locations where this reference can be found.",
     )
 
 

{destiny_sdk-0.1.3 → destiny_sdk-0.1.5}/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."""