entitysdk 0.2.3__tar.gz → 0.2.5__tar.gz

{entitysdk-0.2.3/src/entitysdk.egg-info → entitysdk-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.2.3
+Version: 0.2.5
 Summary: Python library for interacting with the entitycore service
 Author-email: Open Brain Institute <info@openbraininstitute.org>
 Maintainer-email: Open Brain Institute <info@openbraininstitute.org>
@@ -51,7 +51,7 @@ pip install obi-auth
 ```python
 from obi_auth import get_token
 
-access_token = get_token(environment="staging")
+token = get_token(environment="staging")
 ```
 
 ## Quick Start
@@ -67,12 +67,12 @@ client = Client(
     project_context=ProjectContext(
         project_id=UUID("your-project-id"),
         virtual_lab_id=UUID("your-lab-id")
-    )
+    ),
     environment="staging"
 )
 
 # Search for morphologies
-iterator = client.search(
+iterator = client.search_entity(
     entity_type=ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,

{entitysdk-0.2.3 → entitysdk-0.2.5}/README.md

@@ -30,7 +30,7 @@ pip install obi-auth
 ```python
 from obi_auth import get_token
 
-access_token = get_token(environment="staging")
+token = get_token(environment="staging")
 ```
 
 ## Quick Start
@@ -46,12 +46,12 @@ client = Client(
     project_context=ProjectContext(
         project_id=UUID("your-project-id"),
         virtual_lab_id=UUID("your-lab-id")
-    )
+    ),
     environment="staging"
 )
 
 # Search for morphologies
-iterator = client.search(
+iterator = client.search_entity(
     entity_type=ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,

{entitysdk-0.2.3 → entitysdk-0.2.5}/src/entitysdk/models/agent.py

@@ -33,20 +33,20 @@ class Person(Agent):
             description="The type of this agent. Should be 'agent'",
         ),
     ] = "person"
-    givenName: Annotated[
-        str,
+    given_name: Annotated[
+        str | None,
         Field(
             examples=["John", "Jane"],
             description="The given name of the person.",
         ),
-    ]
-    familyName: Annotated[
-        str,
+    ] = None
+    family_name: Annotated[
+        str | None,
         Field(
             examples=["Doe", "Smith"],
             description="The family name of the person.",
         ),
-    ]
+    ] = None
 
 
 class Organization(Agent):

{entitysdk-0.2.3 → entitysdk-0.2.5}/src/entitysdk/models/entity.py

@@ -35,11 +35,11 @@ class Entity(Identifiable, HasAssets):
             description="The type of this Entity.",
         ),
     ] = None
-    createdBy: Annotated[
+    created_by: Annotated[
         AgentUnion | None,
         Field(description="The agent that created this entity."),
     ] = None
-    updatedBy: Annotated[
+    updated_by: Annotated[
         AgentUnion | None,
         Field(
             description="The agent that updated this entity.",

{entitysdk-0.2.3 → entitysdk-0.2.5}/src/entitysdk/serdes.py

@@ -22,7 +22,7 @@ def serialize_entity(entity: BaseModel) -> dict:
     data = entity.model_dump(
         mode="json",
         exclude=SERIALIZATION_EXCLUDE_KEYS,
-        exclude_none=True,
+        exclude_none=False,
     )
     processed = _convert_identifiables_to_ids(data)
     return processed

{entitysdk-0.2.3 → entitysdk-0.2.5/src/entitysdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.2.3
+Version: 0.2.5
 Summary: Python library for interacting with the entitycore service
 Author-email: Open Brain Institute <info@openbraininstitute.org>
 Maintainer-email: Open Brain Institute <info@openbraininstitute.org>
@@ -51,7 +51,7 @@ pip install obi-auth
 ```python
 from obi_auth import get_token
 
-access_token = get_token(environment="staging")
+token = get_token(environment="staging")
 ```
 
 ## Quick Start
@@ -67,12 +67,12 @@ client = Client(
     project_context=ProjectContext(
         project_id=UUID("your-project-id"),
         virtual_lab_id=UUID("your-lab-id")
-    )
+    ),
     environment="staging"
 )
 
 # Search for morphologies
-iterator = client.search(
+iterator = client.search_entity(
     entity_type=ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,

{entitysdk-0.2.3 → entitysdk-0.2.5}/tests/unit/models/data/ion_channel_model.json

@@ -3,8 +3,8 @@
   "type": "ion_channel_model",
   "update_date": "2024-10-29T13:36:30.827776Z",
   "creation_date": "2024-09-10T14:25:03.707956Z",
-  "createdBy": null,
-  "updatedBy": null,
+  "created_by": null,
+  "updated_by": null,
   "authorized_public": true,
   "authorized_project_id": "c73ac3a5-3b7d-41bc-92e7-9f9309a49300",
   "name": "Ca_HVA",

{entitysdk-0.2.3 → entitysdk-0.2.5}/tests/unit/models/data/reconstruction_morphology.json

@@ -3,8 +3,8 @@
   "type": "reconstruction_morphology",
   "update_date": "2024-10-29T13:36:30.827776Z",
   "creation_date": "2024-09-10T14:25:03.707956Z",
-  "createdBy": null,
-  "updatedBy": null,
+  "created_by": null,
+  "updated_by": null,
   "authorized_public": true,
   "authorized_project_id": "0dbced5f-cc3d-488a-8c7f-cfb8ea039dc6",
   "assets": [
@@ -117,8 +117,8 @@
         "creation_date": "2021-03-17T16:59:51.555000Z",
         "type": "person",
         "pref_label": "Maurizio Pezzoli Gonzalez",
-        "givenName": "Maurizio",
-        "familyName": "Pezzoli Gonzalez"
+        "given_name": "Maurizio",
+        "family_name": "Pezzoli Gonzalez"
       },
       "role": {
         "id": "8b06e557-277b-4b0c-a439-bfb02d41927c",

{entitysdk-0.2.3 → entitysdk-0.2.5}/tests/unit/models/test_agent.py

@@ -6,13 +6,13 @@ from ..util import MOCK_UUID
 
 def test_person_entity():
     agent = test_module.Person(
-        givenName="foo",
-        familyName="bar",
+        given_name="foo",
+        family_name="bar",
         pref_label="test",
         type="person",
     )
-    assert agent.givenName == "foo"
-    assert agent.familyName == "bar"
+    assert agent.given_name == "foo"
+    assert agent.family_name == "bar"
     assert agent.pref_label == "test"
     assert agent.type == "person"
 
@@ -57,8 +57,8 @@ def test_agent_discriminated_union():
             "agent": {
                 "type": "person",
                 "pref_label": "foo",
-                "givenName": "John",
-                "familyName": "Smith",
+                "given_name": "John",
+                "family_name": "Smith",
             },
         }
     )

{entitysdk-0.2.3 → entitysdk-0.2.5}/tests/unit/models/test_contribution.py

@@ -15,7 +15,7 @@ def test_role(role):
 
 
 def test_contribution(role):
-    person = agent.Person(type="person", givenName="foo", familyName="bar", pref_label="test")
+    person = agent.Person(type="person", given_name="foo", family_name="bar", pref_label="test")
 
     res = test_module.Contribution(
         agent=person,