entitysdk 0.1.2__tar.gz → 0.2.0__tar.gz

{entitysdk-0.1.2/src/entitysdk.egg-info → entitysdk-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.1.2
+Version: 0.2.0
 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>

{entitysdk-0.1.2 → entitysdk-0.2.0}/src/entitysdk/client.py

@@ -13,7 +13,8 @@ from entitysdk.models.asset import Asset, LocalAssetMetadata
 from entitysdk.models.core import Identifiable
 from entitysdk.result import IteratorResult
 from entitysdk.token_manager import TokenManager
-from entitysdk.typedef import ID
+from entitysdk.typedef import ID, DeploymentEnvironment
+from entitysdk.util import build_api_url
 
 
 class Client:
@@ -21,10 +22,11 @@ class Client:
 
     def __init__(
         self,
-        api_url: str,
+        api_url: str | None = None,
         project_context: ProjectContext | None = None,
         http_client: httpx.Client | None = None,
         token_manager: TokenManager | None = None,
+        environment: DeploymentEnvironment | str | None = None,
     ) -> None:
         """Initialize client.
 
@@ -33,12 +35,39 @@ class Client:
             project_context: Project context.
             http_client: Optional HTTP client to use.
             token_manager: Optional token manager to use.
+            environment: Deployment environent.
         """
-        self.api_url = api_url.rstrip("/")
+        try:
+            environment = DeploymentEnvironment(environment) if environment else None
+        except ValueError:
+            raise EntitySDKError(
+                f"'{environment}' is not a valid DeploymentEnvironment. "
+                f"Choose one of: {[str(env) for env in DeploymentEnvironment]}"
+            ) from None
+
+        self.api_url = self._handle_api_url(
+            api_url=api_url,
+            environment=environment,
+        )
         self.project_context = project_context
         self._http_client = http_client or httpx.Client()
         self._token_manager = token_manager
 
+    @staticmethod
+    def _handle_api_url(api_url: str | None, environment: DeploymentEnvironment | None) -> str:
+        """Return or create api url."""
+        match (api_url, environment):
+            case (str(), None):
+                return api_url
+            case (None, DeploymentEnvironment()):
+                return build_api_url(environment=environment)
+            case (None, None):
+                raise EntitySDKError("Neither api_url nor environment have been defined.")
+            case (str(), DeploymentEnvironment()):
+                raise EntitySDKError("Either the api_url or environment must be defined, not both.")
+            case _:
+                raise EntitySDKError("Either api_url or environment is of the wrong type.")
+
     def _get_token(self, override_token: str | None = None) -> str:
         """Get a token either from an override or from the token manager.
 

entitysdk-0.2.0/src/entitysdk/common.py

@@ -0,0 +1,45 @@
+"""Common stuff."""
+
+import re
+from typing import Self
+from uuid import UUID
+
+from pydantic import BaseModel
+
+from entitysdk.exception import EntitySDKError
+from entitysdk.typedef import DeploymentEnvironment
+
+UUID_RE = "[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}"
+
+
+VLAB_URL_PATTERN = re.compile(
+    r"^https:\/\/(?P<env>staging|www)\.openbraininstitute\.org"
+    rf"\/app\/virtual-lab\/lab\/(?P<vlab>{UUID_RE})"
+    rf"\/project\/(?P<proj>{UUID_RE})(?:\/.*)?$"
+)
+
+
+class ProjectContext(BaseModel):
+    """Project context."""
+
+    project_id: UUID
+    virtual_lab_id: UUID
+    environment: DeploymentEnvironment | None = None
+
+    @classmethod
+    def from_vlab_url(cls, url: str) -> Self:
+        """Construct a ProjectContext from a virtual lab url."""
+        result = VLAB_URL_PATTERN.match(url)
+
+        if not result:
+            raise EntitySDKError(f"Badly formed vlab url: {url}")
+
+        env = {
+            "www": DeploymentEnvironment.production,
+            "staging": DeploymentEnvironment.staging,
+        }[result.group("env")]
+
+        vlab_id = UUID(result.group("vlab"))
+        proj_id = UUID(result.group("proj"))
+
+        return cls(project_id=proj_id, virtual_lab_id=vlab_id, environment=env)

entitysdk-0.2.0/src/entitysdk/config.py

@@ -0,0 +1,37 @@
+"""Configuration for this library."""
+
+from typing import Annotated
+
+from pydantic import Field
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    """Constants for this library."""
+
+    page_size: Annotated[
+        int | None,
+        Field(
+            alias="ENTITYSDK_PAGE_SIZE",
+            description="Default pagination page size, or None to use server default.",
+        ),
+    ] = None
+
+    staging_api_url: Annotated[
+        str,
+        Field(
+            alias="ENTITYSDK_STAGING_API_URL",
+            description="Default staging entitycore API url.",
+        ),
+    ] = "https://staging.openbraininstitute.org/api/entitycore"
+
+    production_api_url: Annotated[
+        str,
+        Field(
+            alias="ENTITYSDK_PRODUCTION_API_URL",
+            description="Default production entitycore API url.",
+        ),
+    ] = "https://www.openbraininstitute.org/api/entitycore"
+
+
+settings = Settings()

{entitysdk-0.1.2 → entitysdk-0.2.0}/src/entitysdk/models/morphology.py

@@ -190,13 +190,6 @@ class ReconstructionMorphology(HasAssets, Entity):
             description="The description of the morphology.",
         ),
     ]
-    pref_label: Annotated[
-        str | None,
-        Field(
-            examples=["layer 5 Pyramidal Cell"],
-            description="The preferred label of the morphology.",
-        ),
-    ] = None
     species: Annotated[
         Species,
         Field(

entitysdk-0.2.0/src/entitysdk/typedef.py

@@ -0,0 +1,13 @@
+"""Type definitions."""
+
+import uuid
+from enum import StrEnum
+
+ID = uuid.UUID
+
+
+class DeploymentEnvironment(StrEnum):
+    """Deployment environment."""
+
+    staging = "staging"
+    production = "production"

{entitysdk-0.1.2 → entitysdk-0.2.0}/src/entitysdk/util.py

@@ -10,6 +10,7 @@ from entitysdk.common import ProjectContext
 from entitysdk.config import settings
 from entitysdk.exception import EntitySDKError
 from entitysdk.models.response import ListResponse
+from entitysdk.typedef import DeploymentEnvironment
 
 
 def make_db_api_request(
@@ -126,3 +127,11 @@ def stream_paginated_request(
             if number_of_items >= limit:
                 return
         page += 1
+
+
+def build_api_url(environment: DeploymentEnvironment) -> str:
+    """Return API url for the respective deployment environment."""
+    return {
+        DeploymentEnvironment.staging: settings.staging_api_url,
+        DeploymentEnvironment.production: settings.production_api_url,
+    }[environment]

{entitysdk-0.1.2 → entitysdk-0.2.0/src/entitysdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.1.2
+Version: 0.2.0
 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>

{entitysdk-0.1.2 → entitysdk-0.2.0}/src/entitysdk.egg-info/SOURCES.txt

@@ -46,6 +46,7 @@ tests/unit/__init__.py
 tests/unit/conftest.py
 tests/unit/test_base.py
 tests/unit/test_client.py
+tests/unit/test_common.py
 tests/unit/test_config.py
 tests/unit/test_result.py
 tests/unit/test_route.py

{entitysdk-0.1.2 → entitysdk-0.2.0}/tests/unit/models/data/reconstruction_morphology.json

@@ -99,7 +99,6 @@
     "children": []
   },
   "description": "Neuronal morphology of excitatory neuron cell 'mpg150211_A_idA' in Field CA1, pyramidal layer of cell type SR_PC. A neuron that releases excitatory neurotransmitters. This neuron doesn't have axon, has a basal dendrite and apical dendrite.",
-  "pref_label": null,
   "species": {
     "id": "0895fa61-fa6d-4674-9014-7300f9edf8da",
     "update_date": "2025-03-29T16:48:36.175090Z",

{entitysdk-0.1.2 → entitysdk-0.2.0}/tests/unit/test_client.py

@@ -1,13 +1,43 @@
 import io
+import re
 import uuid
 from unittest.mock import patch
 
 import pytest
 
 from entitysdk.client import Client
+from entitysdk.config import settings
 from entitysdk.exception import EntitySDKError
 from entitysdk.mixin import HasAssets
 from entitysdk.models.entity import Entity
+from entitysdk.typedef import DeploymentEnvironment
+
+
+def test_client_api_url():
+    client = Client(api_url="foo")
+    assert client.api_url == "foo"
+
+    client = Client(api_url=None, environment="staging")
+    assert client.api_url == settings.staging_api_url
+
+    client = Client(api_url=None, environment="production")
+    assert client.api_url == settings.production_api_url
+
+    with pytest.raises(
+        EntitySDKError, match="Either the api_url or environment must be defined, not both."
+    ):
+        Client(api_url="foo", environment="staging")
+
+    with pytest.raises(EntitySDKError, match="Neither api_url nor environment have been defined."):
+        Client()
+
+    with pytest.raises(EntitySDKError, match="Either api_url or environment is of the wrong type."):
+        Client(api_url=int)
+
+    str_envs = [str(env) for env in DeploymentEnvironment]
+    expected = f"'foo' is not a valid DeploymentEnvironment. Choose one of: {str_envs}"
+    with pytest.raises(EntitySDKError, match=re.escape(expected)):
+        Client(environment="foo")
 
 
 def test_client_get_token():

entitysdk-0.2.0/tests/unit/test_common.py

@@ -0,0 +1,89 @@
+import pytest
+
+from entitysdk import common as test_module
+from entitysdk.exception import EntitySDKError
+from entitysdk.typedef import DeploymentEnvironment
+
+VLAB_ID = "ff888f05-f314-4702-8a92-b86f754270bb"
+PROJ_ID = "f373e771-3a2f-4f45-ab59-0955efd7b1f4"
+
+
+@pytest.mark.parametrize(
+    ("url", "expected"),
+    [
+        (
+            f"https://staging.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/{PROJ_ID}/home",
+            test_module.ProjectContext(
+                virtual_lab_id=VLAB_ID,
+                project_id=PROJ_ID,
+                environment=DeploymentEnvironment.staging,
+            ),
+        ),
+        (
+            f"https://staging.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/{PROJ_ID}",
+            test_module.ProjectContext(
+                virtual_lab_id=VLAB_ID,
+                project_id=PROJ_ID,
+                environment=DeploymentEnvironment.staging,
+            ),
+        ),
+        (
+            f"https://www.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/{PROJ_ID}/home",
+            test_module.ProjectContext(
+                virtual_lab_id=VLAB_ID,
+                project_id=PROJ_ID,
+                environment=DeploymentEnvironment.production,
+            ),
+        ),
+        (
+            f"https://www.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/{PROJ_ID}",
+            test_module.ProjectContext(
+                virtual_lab_id=VLAB_ID,
+                project_id=PROJ_ID,
+                environment=DeploymentEnvironment.production,
+            ),
+        ),
+    ],
+)
+def test_project_context__from_vlab_url(url, expected):
+    res = test_module.ProjectContext.from_vlab_url(url)
+    assert res == expected
+
+
+@pytest.mark.parametrize(
+    ("url", "expected_error", "expected_msg"),
+    [
+        ("asdf", EntitySDKError, "Badly formed vlab url"),
+        ("https://", EntitySDKError, "Badly formed vlab url"),
+        ("https://openbraininstitute.org", EntitySDKError, "Badly formed vlab url"),
+        ("https://staging.openbraininstitute.org", EntitySDKError, "Badly formed vlab url"),
+        (
+            "https://staging.openbraininstitute.org/app/virtual-lab/lab/foo",
+            EntitySDKError,
+            "Badly formed vlab url",
+        ),
+        (
+            "https://staging.openbraininstitute.org/app/virtual-lab/lab/foo/project/bar",
+            EntitySDKError,
+            "Badly formed vlab url",
+        ),
+        (
+            f"https://dev.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/{PROJ_ID}",
+            EntitySDKError,
+            "Badly formed vlab url",
+        ),
+        (
+            f"https://dev.openbraininstitute.org/app/virtual-lab/lab/foo/project/{PROJ_ID}",
+            EntitySDKError,
+            "Badly formed vlab url",
+        ),
+        (
+            f"https://dev.openbraininstitute.org/app/virtual-lab/lab/{VLAB_ID}/project/bar",
+            EntitySDKError,
+            "Badly formed vlab url",
+        ),
+    ],
+)
+def test_project_context__from_vlab_url__raises(url, expected_error, expected_msg):
+    with pytest.raises(expected_error, match=expected_msg):
+        test_module.ProjectContext.from_vlab_url(url)

entitysdk-0.1.2/src/entitysdk/common.py

@@ -1,12 +0,0 @@
-"""Common stuff."""
-
-from dataclasses import dataclass
-from uuid import UUID
-
-
-@dataclass
-class ProjectContext:
-    """Project context."""
-
-    project_id: UUID
-    virtual_lab_id: UUID

entitysdk-0.1.2/src/entitysdk/config.py

@@ -1,21 +0,0 @@
-"""Configuration for this library."""
-
-from typing import Annotated
-
-from pydantic import Field
-from pydantic_settings import BaseSettings
-
-
-class Settings(BaseSettings):
-    """Constants for this library."""
-
-    page_size: Annotated[
-        int | None,
-        Field(
-            alias="ENTITYSDK_PAGE_SIZE",
-            description="Default pagination page size, or None to use server default.",
-        ),
-    ] = None
-
-
-settings = Settings()

entitysdk-0.1.2/src/entitysdk/typedef.py

@@ -1,5 +0,0 @@
-"""Type definitions."""
-
-import uuid
-
-ID = uuid.UUID