futurehouse-client 0.3.20.dev295__tar.gz → 0.4.0__tar.gz

{futurehouse_client-0.3.20.dev295/futurehouse_client.egg-info → futurehouse_client-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.3.20.dev295
+Version: 0.4.0
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 License:                                  Apache License

{futurehouse_client-0.3.20.dev295 → futurehouse_client-0.4.0}/futurehouse_client/clients/rest_client.py

@@ -58,6 +58,7 @@ from futurehouse_client.models.app import (
     TrajectoryQueryParams,
 )
 from futurehouse_client.models.rest import (
+    DiscoveryResponse,
     ExecutionStatus,
     UserAgentRequest,
     UserAgentRequestPostPayload,
@@ -139,6 +140,14 @@ class ProjectError(RestClientError):
     """Raised when there's an error with trajectory group operations."""
 
 
+class DiscoveryCreationError(RestClientError):
+    """Raised when there's an error creating a discovery."""
+
+
+class DiscoveryFetchError(RestClientError):
+    """Raised when there's an error fetching a discovery."""
+
+
 class InvalidTaskDescriptionError(Exception):
     """Raised when the task description is invalid or empty."""
 
@@ -1737,11 +1746,18 @@ class RestClient:
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
         retry=retry_if_connection_error,
     )
-    def create_project(self, name: str) -> str:
+    def create_project(
+        self,
+        name: str,
+        shared_with_organizations: list[int] | None = None,
+        shared_with_users: list[str] | None = None,
+    ) -> str:
         """Create a new project.
 
         Args:
             name: The name for the project
+            shared_with_organizations: List of organization IDs to share the project with
+            shared_with_users: List of user emails to share the project with
 
         Returns:
             UUID of the created project
@@ -1750,7 +1766,11 @@ class RestClient:
             ProjectError: If there's an error creating the project
         """
         try:
-            data = {"name": name}
+            data = {
+                "name": name,
+                "shared_with_organizations": shared_with_organizations,
+                "shared_with_users": shared_with_users,
+            }
             response = self.client.post("/v0.1/projects", json=data)
             response.raise_for_status()
             return response.json()
@@ -1802,11 +1822,18 @@ class RestClient:
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
         retry=retry_if_connection_error,
     )
-    async def acreate_project(self, name: str) -> str:
+    async def acreate_project(
+        self,
+        name: str,
+        shared_with_organizations: list[int] | None = None,
+        shared_with_users: list[str] | None = None,
+    ) -> str:
         """Asynchronously create a new project.
 
         Args:
             name: The name for the project
+            shared_with_organizations: List of organization IDs to share the project with
+            shared_with_users: List of user emails to share the project with
 
         Returns:
             UUID of the created project
@@ -1815,7 +1842,11 @@ class RestClient:
             ProjectError: If there's an error creating the project
         """
         try:
-            data = {"name": name}
+            data = {
+                "name": name,
+                "shared_with_organizations": shared_with_organizations,
+                "shared_with_users": shared_with_users,
+            }
             response = await self.async_client.post("/v0.1/projects", json=data)
             response.raise_for_status()
             return response.json()
@@ -2326,6 +2357,108 @@ class RestClient:
                 f"An unexpected error occurred while responding to the request: {e!r}."
             ) from e
 
+    def create_discovery(
+        self,
+        project_id: UUID,
+        world_model_id: UUID,
+        dataset_id: UUID,
+        description: str,
+        associated_trajectories: list[UUID],
+        validation_level: int,
+    ) -> UUID:
+        """Create a new discovery.
+
+        Args:
+            project_id: The ID of the project the discovery is associated with.
+            world_model_id: The ID of the world model the discovery is associated with.
+            dataset_id: The ID of the dataset the discovery is associated with.
+            description: The description of the discovery.
+            associated_trajectories: The IDs of the trajectories to associate with the discovery.
+            validation_level: The validation level of the discovery.
+
+        Returns:
+            The ID of the created discovery.
+
+        Raises:
+            DiscoveryCreationError: If there's an error creating the discovery.
+        """
+        try:
+            data = {
+                "project_id": str(project_id),
+                "world_model_id": str(world_model_id),
+                "dataset_id": str(dataset_id),
+                "description": description,
+                "associated_trajectories": [
+                    str(trajectory) for trajectory in associated_trajectories
+                ],
+                "validation_level": validation_level,
+            }
+            response = self.client.post("/v0.1/discoveries", json=data)
+            response.raise_for_status()
+            return UUID(response.json())
+        except HTTPStatusError as e:
+            raise DiscoveryCreationError(
+                f"Error creating discovery: {e.response.status_code} - {e.response.text}"
+            ) from e
+        except Exception as e:
+            raise DiscoveryCreationError(f"Error creating discovery: {e!r}") from e
+
+    def get_discovery(self, discovery_id: UUID) -> DiscoveryResponse:
+        """Get a discovery by its ID.
+
+        Args:
+            discovery_id: The ID of the discovery to get.
+
+        Returns:
+            The discovery.
+
+        Raises:
+            DiscoveryFetchError: If there's an error fetching the discovery.
+        """
+        try:
+            response = self.client.get(f"/v0.1/discoveries/{discovery_id}")
+            response.raise_for_status()
+            return DiscoveryResponse.model_validate(response.json())
+        except HTTPStatusError as e:
+            raise DiscoveryFetchError(
+                f"Error fetching discovery: {e.response.status_code} - {e.response.text}"
+            ) from e
+        except Exception as e:
+            raise DiscoveryFetchError(f"Error fetching discovery: {e!r}") from e
+
+    def list_discoveries_for_project(
+        self, project_id: UUID, limit: int = 50, offset: int = 0
+    ) -> list[DiscoveryResponse]:
+        """List discoveries for a specific project.
+
+        Args:
+            project_id: The ID of the project to get discoveries for.
+            limit: The maximum number of discoveries to return.
+            offset: The number of discoveries to skip.
+
+        Returns:
+            A list of discoveries for the specified project.
+
+        Raises:
+            DiscoveryFetchError: If there's an error fetching the discoveries.
+        """
+        try:
+            response = self.client.get(
+                f"/v0.1/projects/{project_id}/discoveries",
+                params={"limit": limit, "offset": offset},
+            )
+            response.raise_for_status()
+            data = response.json()
+            return [DiscoveryResponse.model_validate(d) for d in data]
+        except HTTPStatusError as e:
+            raise DiscoveryFetchError(
+                f"Error fetching discoveries for project: {e.response.status_code} - {e.response.text}"
+            ) from e
+        except Exception as e:
+            raise DiscoveryFetchError(
+                f"Error fetching discoveries for project: {e!r}"
+            ) from e
+
 
 def get_installed_packages() -> dict[str, str]:
     """Returns a dictionary of installed packages and their versions."""

{futurehouse_client-0.3.20.dev295 → futurehouse_client-0.4.0}/futurehouse_client/models/rest.py

@@ -111,6 +111,7 @@ class UserAgentRequestPostPayload(BaseModel):
     status: UserAgentRequestStatus = UserAgentRequestStatus.PENDING
     expires_in_seconds: int | None = None
     user_response_task: JsonValue | None = None
+    notify_user: JsonValue = {"email": True, "sms": False}
 
 
 class UserAgentResponsePayload(BaseModel):
@@ -118,3 +119,16 @@ class UserAgentResponsePayload(BaseModel):
 
     response: JsonValue
     response_world_model_edit_id: UUID | None = None
+
+
+class DiscoveryResponse(BaseModel):
+    """Response model for a discovery request. This model is received from the API."""
+
+    discovery_id: UUID | str
+    project_id: UUID | str
+    world_model_id: UUID | str
+    dataset_id: UUID | str
+    description: str
+    associated_trajectories: list[UUID | str]
+    validation_level: int
+    created_at: datetime

{futurehouse_client-0.3.20.dev295 → futurehouse_client-0.4.0}/futurehouse_client/version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.20.dev295'
-__version_tuple__ = version_tuple = (0, 3, 20, 'dev295')
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)
+
+__commit_id__ = commit_id = 'g5229864ab'

{futurehouse_client-0.3.20.dev295 → futurehouse_client-0.4.0/futurehouse_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.3.20.dev295
+Version: 0.4.0
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 License:                                  Apache License

{futurehouse_client-0.3.20.dev295 → futurehouse_client-0.4.0}/tests/test_rest.py

@@ -978,6 +978,7 @@ class TestUserAgentRequestOperations:
         payload = UserAgentRequestPostPayload(
             trajectory_id=running_trajectory_id,
             request={"question": "Do you approve?"},
+            notify_user={"email": False, "sms": False},  # avoid sending notifications
         )
         request_id = admin_client.create_user_agent_request(payload)
         assert isinstance(request_id, UUID)
@@ -1045,6 +1046,7 @@ class TestAsyncUserAgentRequestOperations:
                 query="Why would I follow up on this query?",
             ).model_dump(mode="json"),
             expires_in_seconds=10,
+            notify_user={"email": False, "sms": False},  # avoid sending notifications
         )
 
         request_id = await admin_client.acreate_user_agent_request(payload)
@@ -1097,6 +1099,7 @@ class TestAsyncUserAgentRequestOperations:
                 name=JobNames.from_string("dummy"),
                 query="Why would I follow up on this query?",
             ).model_dump(mode="json"),
+            notify_user={"email": False, "sms": False},  # avoid sending notifications
         )
 
         request_id = await admin_client.acreate_user_agent_request(payload)