adaptive-sdk 0.1.14__py3-none-any.whl → 0.12.1__py3-none-any.whl

adaptive_sdk/resources/recipes.py

@@ -1,27 +1,27 @@
 from __future__ import annotations
-import os
+
 import io
-import zipfile
 import mimetypes
+import os
+import zipfile
 from contextlib import contextmanager
-from loguru import logger
-from hypothesis_jsonschema import from_schema
-from typing import TYPE_CHECKING, Sequence, Any
 from pathlib import Path
+from typing import TYPE_CHECKING, Any, Sequence
 
-from adaptive_sdk.graphql_client.fragments import JobData
-from adaptive_sdk.graphql_client.input_types import JobInput
+from hypothesis_jsonschema import from_schema
+from loguru import logger
 
-from .base_resource import SyncAPIResource, AsyncAPIResource, UseCaseResource
 from adaptive_sdk.graphql_client import (
+    CreateRecipeInput,
     CustomRecipeData,
     CustomRecipeFilterInput,
-    CreateRecipeInput,
-    UpdateRecipeInput,
     LabelInput,
+    UpdateRecipeInput,
     Upload,
 )
 
+from .base_resource import AsyncAPIResource, SyncAPIResource, UseCaseResource
+
 if TYPE_CHECKING:
     from adaptive_sdk.client import Adaptive, AsyncAdaptive
 
@@ -36,6 +36,14 @@ class Recipes(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     def list(self, use_case: str | None = None) -> Sequence[CustomRecipeData]:
+        """List all custom recipes for a use case.
+
+        Args:
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            A sequence of custom recipe data objects.
+        """
         filter = CustomRecipeFilterInput()
         return self._gql_client.list_custom_recipes(use_case=self.use_case_key(use_case), filter=filter).custom_recipes
 
@@ -53,18 +61,27 @@ class Recipes(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         Upload a recipe from either a single Python file or a directory (path).
 
         Args:
-            path: Path to a Python file or directory containing the recipe
+            path: Path to a Python file or directory containing the recipe.
             recipe_key: Optional unique key for the recipe. If not provided, inferred from:
                 - File name (without .py) if path is a file
                 - "dir_name/entrypoint_name" if path is a directory and custom entrypoint is specified
                 - Directory name if path is a directory and no custom entrypoint is specified
-            entrypoint: Optional relative path to the entrypoint file within a directory.
-                If specified, this file will be used as main.py. Cannot be used if
-                main.py already exists in the directory, or if path is a file.
-            name: Optional display name for the recipe
-            description: Optional description
-            labels: Optional key-value labels
-            use_case: Optional use case identifier
+            entrypoint: Optional path to the recipe entrypoint file, relative to the `path` directory.
+                **Only applicable when path is a directory.**
+
+                Raises ValueError if:
+                - path is a single file (entrypoint not supported for single files)
+                - path is a directory that already contains main.py
+
+                Raises FileNotFoundError if:
+                - the specified entrypoint file doesn't exist in the directory
+
+                If path is a directory and entrypoint is None:
+                - The directory must contain a main.py file, or FileNotFoundError is raised
+            name: Optional display name for the recipe.
+            description: Optional description.
+            labels: Optional key-value labels.
+            use_case: Optional use case identifier.
         """
         p = Path(path)
         if recipe_key is None:
@@ -91,6 +108,15 @@ class Recipes(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         recipe_key: str,
         use_case: str | None = None,
     ) -> CustomRecipeData | None:
+        """Get details for a specific recipe.
+
+        Args:
+            recipe_key: The key or ID of the recipe.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            The recipe data if found, otherwise None.
+        """
         return self._gql_client.get_custom_recipe(
             id_or_key=recipe_key, use_case=self.use_case_key(use_case)
         ).custom_recipe
@@ -105,6 +131,32 @@ class Recipes(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         labels: Sequence[tuple[str, str]] | None = None,
         use_case: str | None = None,
     ) -> CustomRecipeData:
+        """Update an existing recipe.
+
+        Args:
+            recipe_key: The key of the recipe to update.
+            path: Optional new path to a Python file or directory to replace recipe code.
+                If None, only metadata (name, description, labels) is updated.
+            entrypoint: Optional path to the recipe entrypoint file, relative to the `path` directory.
+                **Only applicable when path is a directory.**
+
+                Raises ValueError if:
+                - path is a single file (entrypoint not supported for single files)
+                - path is a directory that already contains main.py
+
+                Raises FileNotFoundError if:
+                - the specified entrypoint file doesn't exist in the directory
+
+                If path is a directory and entrypoint is None:
+                - The directory must contain a main.py file, or FileNotFoundError is raised
+            name: Optional new display name.
+            description: Optional new description.
+            labels: Optional new key-value labels as tuples of (key, value).
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            The updated recipe data.
+        """
         label_inputs = [LabelInput(key=k, value=v) for k, v in labels] if labels else None
         input = UpdateRecipeInput(
             name=name,
@@ -133,11 +185,32 @@ class Recipes(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         recipe_key: str,
         use_case: str | None = None,
     ) -> bool:
+        """Delete a recipe.
+
+        Args:
+            recipe_key: The key or ID of the recipe to delete.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            True if deletion was successful.
+        """
         return self._gql_client.delete_custom_recipe(
             use_case=self.use_case_key(use_case), id=recipe_key
         ).delete_custom_recipe
 
     def generate_sample_input(self, recipe_key: str, use_case: str | None = None) -> dict:
+        """Generate a sample input dictionary based on the recipe's JSON schema.
+
+        Args:
+            recipe_key: The key or ID of the recipe.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            A sample input dictionary conforming to the recipe's schema.
+
+        Raises:
+            ValueError: If the recipe is not found.
+        """
         recipe_details = self.get(recipe_key=recipe_key, use_case=self.use_case_key(use_case))
         if recipe_details is None:
             raise ValueError(f"Recipe {recipe_key} was not found")
@@ -174,6 +247,14 @@ class AsyncRecipes(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     async def list(self, use_case: str | None = None) -> Sequence[CustomRecipeData]:
+        """List all custom recipes for a use case.
+
+        Args:
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            A sequence of custom recipe data objects.
+        """
         filter = CustomRecipeFilterInput()
         return (
             await self._gql_client.list_custom_recipes(use_case=self.use_case_key(use_case), filter=filter)
@@ -193,18 +274,27 @@ class AsyncRecipes(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         Upload a recipe from either a single Python file or a directory (path).
 
         Args:
-            path: Path to a Python file or directory containing the recipe
+            path: Path to a Python file or directory containing the recipe.
             recipe_key: Optional unique key for the recipe. If not provided, inferred from:
                 - File name (without .py) if path is a file
                 - "dir_name/entrypoint_name" if path is a directory and custom entrypoint is specified
                 - Directory name if path is a directory and no custom entrypoint is specified
-            entrypoint: Optional relative path to the entrypoint file within a directory.
-                If specified, this file will be used as main.py. Cannot be used if
-                main.py already exists in the directory, or if path is a file.
-            name: Optional display name for the recipe
-            description: Optional description
-            labels: Optional key-value labels
-            use_case: Optional use case identifier
+            entrypoint: Optional path to the recipe entrypoint file, relative to the `path` directory.
+                **Only applicable when path is a directory.**
+
+                Raises ValueError if:
+                - path is a single file (entrypoint not supported for single files)
+                - path is a directory that already contains main.py
+
+                Raises FileNotFoundError if:
+                - the specified entrypoint file doesn't exist in the directory
+
+                If path is a directory and entrypoint is None:
+                - The directory must contain a main.py file, or FileNotFoundError is raised
+            name: Optional display name for the recipe.
+            description: Optional description.
+            labels: Optional key-value labels as tuples of (key, value).
+            use_case: Optional use case identifier.
         """
         p = Path(path)
         if recipe_key is None:
@@ -232,6 +322,15 @@ class AsyncRecipes(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         recipe_key: str,
         use_case: str | None = None,
     ) -> CustomRecipeData | None:
+        """Get details for a specific recipe.
+
+        Args:
+            recipe_key: The key or ID of the recipe.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            The recipe data if found, otherwise None.
+        """
         return (
             await self._gql_client.get_custom_recipe(id_or_key=recipe_key, use_case=self.use_case_key(use_case))
         ).custom_recipe
@@ -246,6 +345,32 @@ class AsyncRecipes(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         labels: Sequence[tuple[str, str]] | None = None,
         use_case: str | None = None,
     ) -> CustomRecipeData:
+        """Update an existing recipe.
+
+        Args:
+            recipe_key: The key or ID of the recipe to update.
+            path: Optional new path to a Python file or directory to replace recipe code.
+                If None, only metadata (name, description, labels) is updated.
+            entrypoint: Optional path to the recipe entrypoint file, relative to the `path` directory.
+                **Only applicable when path is a directory.**
+
+                Raises ValueError if:
+                - path is a single file (entrypoint not supported for single files)
+                - path is a directory that already contains main.py
+
+                Raises FileNotFoundError if:
+                - the specified entrypoint file doesn't exist in the directory
+
+                If path is a directory and entrypoint is None:
+                - The directory must contain a main.py file, or FileNotFoundError is raised
+            name: Optional new display name.
+            description: Optional new description.
+            labels: Optional new key-value labels as tuples of (key, value).
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            The updated recipe data.
+        """
         label_inputs = [LabelInput(key=k, value=v) for k, v in labels] if labels else None
         input = UpdateRecipeInput(
             name=name,
@@ -278,11 +403,32 @@ class AsyncRecipes(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         recipe_key: str,
         use_case: str | None = None,
     ) -> bool:
+        """Delete a recipe.
+
+        Args:
+            recipe_key: The key or ID of the recipe to delete.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            True if deletion was successful.
+        """
         return (
             await self._gql_client.delete_custom_recipe(use_case=self.use_case_key(use_case), id=recipe_key)
         ).delete_custom_recipe
 
     async def generate_sample_input(self, recipe_key: str, use_case: str | None = None) -> dict:
+        """Generate a sample input dictionary based on the recipe's JSON schema.
+
+        Args:
+            recipe_key: The key or ID of the recipe.
+            use_case: Optional use case key. Falls back to client's default.
+
+        Returns:
+            A sample input dictionary conforming to the recipe's schema.
+
+        Raises:
+            ValueError: If the recipe is not found.
+        """
         recipe_details = await self.get(recipe_key=recipe_key, use_case=self.use_case_key(use_case))
         if recipe_details is None:
             raise ValueError(f"Recipe {recipe_key} was not found")
@@ -359,8 +505,8 @@ def _validate_recipe_directory(dir_path: Path, entrypoint: str | None = None) ->
     if entrypoint:
         if main_py_exists:
             raise ValueError(
-                f"Cannot specify entrypoint when main.py already exists in directory: {dir_path}. "
-                f"Either remove/rename main.py or use it directly without specifying an entrypoint."
+                "Cannot specify entrypoint when main.py already exists in directory: "
+                f"{dir_path}. Either remove/rename main.py or use it directly without specifying an entrypoint."
             )
         entrypoint_path = dir_path / entrypoint
         if not entrypoint_path.exists() or not entrypoint_path.is_file():
@@ -368,7 +514,7 @@ def _validate_recipe_directory(dir_path: Path, entrypoint: str | None = None) ->
     else:
         if not main_py_exists:
             raise FileNotFoundError(
-                f"Directory must contain a 'main.py' file, or in alternative you must specify an `entrypoint` file"
+                "Directory must contain a 'main.py' file, or in alternative you must specify an `entrypoint` file"
             )
 
 
@@ -393,7 +539,7 @@ def _upload_from_path(path: str, entrypoint: str | None = None):
 
     if p.is_file():
         if entrypoint:
-            raise ValueError(f"Entrypoint parameter is not supported for single file recipe uploads")
+            raise ValueError("Entrypoint parameter is not supported for single file recipe uploads")
         _validate_python_file(p)
         filename = p.name
         content_type = mimetypes.guess_type(str(p))[0] or "application/octet-stream"
@@ -408,7 +554,7 @@ def _upload_from_path(path: str, entrypoint: str | None = None):
         try:
             zip_buffer = _zip_directory_to_bytes_io(p, entrypoint=entrypoint)
         except Exception:
-            logger.error(f"Failed to create in-memory zip for directory upload.")
+            logger.error("Failed to create in-memory zip for directory upload.")
             raise
         filename = f"{p.name}.zip"
         try:

adaptive_sdk/resources/roles.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING, List
 
-from adaptive_sdk.graphql_client import ListRolesRoles, RoleCreate, CreateRoleCreateRole
+from adaptive_sdk.graphql_client import CreateRoleCreateRole, ListRolesRoles, RoleCreate
 
-from .base_resource import SyncAPIResource, AsyncAPIResource, UseCaseResource
+from .base_resource import AsyncAPIResource, SyncAPIResource, UseCaseResource
 
 if TYPE_CHECKING:
     from adaptive_sdk.client import Adaptive, AsyncAdaptive
@@ -19,11 +20,14 @@ class Roles(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     def list(self) -> List[ListRolesRoles]:
+        """List all roles.
+
+        Returns:
+            A list of role objects.
+        """
         return self._gql_client.list_roles().roles
 
-    def create(
-        self, key: str, permissions: List[str], name: str | None = None
-    ) -> CreateRoleCreateRole:
+    def create(self, key: str, permissions: List[str], name: str | None = None) -> CreateRoleCreateRole:
         """
         Creates new role.
 
@@ -46,11 +50,14 @@ class AsyncRoles(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     async def list(self) -> List[ListRolesRoles]:
+        """List all roles.
+
+        Returns:
+            A list of role objects.
+        """
         return (await self._gql_client.list_roles()).roles
 
-    async def create(
-        self, key: str, permissions: List[str], name: str | None = None
-    ) -> CreateRoleCreateRole:
+    async def create(self, key: str, permissions: List[str], name: str | None = None) -> CreateRoleCreateRole:
         """
         Creates new role.
 

adaptive_sdk/resources/teams.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING, List
 
 from adaptive_sdk.graphql_client import CreateTeamCreateTeam, ListTeamsTeams, TeamCreate
 
-from .base_resource import SyncAPIResource, AsyncAPIResource, UseCaseResource
+from .base_resource import AsyncAPIResource, SyncAPIResource, UseCaseResource
 
 if TYPE_CHECKING:
     from adaptive_sdk.client import Adaptive, AsyncAdaptive
@@ -19,9 +20,23 @@ class Teams(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     def list(self) -> List[ListTeamsTeams]:
+        """List all teams.
+
+        Returns:
+            A list of team objects.
+        """
         return self._gql_client.list_teams().teams
 
     def create(self, key: str, name: str | None = None) -> CreateTeamCreateTeam:
+        """Create a new team.
+
+        Args:
+            key: Unique key for the team.
+            name: Human-readable team name. If not provided, defaults to key.
+
+        Returns:
+            The created team data.
+        """
         input = TeamCreate(key=key, name=name or key)
         return self._gql_client.create_team(input).create_team
 
@@ -36,8 +51,22 @@ class AsyncTeams(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         UseCaseResource.__init__(self, client)
 
     async def list(self) -> List[ListTeamsTeams]:
+        """List all teams.
+
+        Returns:
+            A list of team objects.
+        """
         return (await self._gql_client.list_teams()).teams
 
     async def create(self, key: str, name: str | None = None) -> CreateTeamCreateTeam:
+        """Create a new team.
+
+        Args:
+            key: Unique key for the team.
+            name: Human-readable team name. If not provided, defaults to key.
+
+        Returns:
+            The created team data.
+        """
         input = TeamCreate(key=key, name=name or key)
         return (await self._gql_client.create_team(input)).create_team

adaptive_sdk/resources/use_cases.py

@@ -1,16 +1,18 @@
 from __future__ import annotations
-from typing import Sequence, TYPE_CHECKING
+
+from typing import TYPE_CHECKING, Sequence
+
 from loguru import logger
 
 from adaptive_sdk.graphql_client import (
     UseCaseCreate,
-    UseCaseSettingsInput,
     UseCaseData,
-    UseCaseShares,
+    UseCaseSettingsInput,
     UseCaseShareInput,
+    UseCaseShares,
 )
 
-from .base_resource import SyncAPIResource, AsyncAPIResource, UseCaseResource
+from .base_resource import AsyncAPIResource, SyncAPIResource, UseCaseResource
 
 if TYPE_CHECKING:
     from adaptive_sdk.client import Adaptive, AsyncAdaptive
@@ -40,6 +42,7 @@ class UseCase(SyncAPIResource, UseCaseResource):  # type: ignore[misc]
             name: Human-readable use case name which will be rendered in the UI.
                 If not set, will be the same as `key`.
             description: Description of model which will be rendered in the UI.
+            team: Team key to associate the use case with.
         """
 
         input = UseCaseCreate(
@@ -155,7 +158,6 @@ class AsyncUseCase(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
         name: str | None = None,
         description: str | None = None,
         team: str | None = None,
-        default_feedback_key: str | None = None,
     ) -> UseCaseData:
         """
         Create new use case.
@@ -165,13 +167,14 @@ class AsyncUseCase(AsyncAPIResource, UseCaseResource):  # type: ignore[misc]
             name: Human-readable use case name which will be rendered in the UI.
                 If not set, will be the same as `key`.
             description: Description of model which will be rendered in the UI.
+            team: Team key to associate the use case with.
         """
         input = UseCaseCreate(
             name=name if name else key,
             key=key,
             description=description,
             team=team,
-            settings=UseCaseSettingsInput(defaultMetric=default_feedback_key),
+            settings=UseCaseSettingsInput(defaultMetric=None),
         )
         result = await self._gql_client.create_use_case(input)
         return result.create_use_case

adaptive_sdk/resources/users.py

@@ -1,16 +1,17 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING, Sequence
 
 from adaptive_sdk.graphql_client import (
-    UserData,
+    TeamMemberRemove,
     TeamMemberSet,
     UpdateUserSetTeamMember,
-    TeamMemberRemove,
     UserCreate,
     UserCreateTeamWithRole,
+    UserData,
 )
 
-from .base_resource import SyncAPIResource, AsyncAPIResource
+from .base_resource import AsyncAPIResource, SyncAPIResource
 
 if TYPE_CHECKING:
     from adaptive_sdk.client import Adaptive, AsyncAdaptive
@@ -36,20 +37,23 @@ class Users(SyncAPIResource):  # type: ignore[misc]
         """
         return self._gql_client.list_users().users
 
-    def create(
-        self, email: str, name: str, teams_with_role: Sequence[tuple[str, str]]
-    ) -> UserData:
+    def create(self, email: str, name: str, teams_with_role: Sequence[tuple[str, str]]) -> UserData:
         """
-        Create a user and with preset teams and role
+        Create a user with preset teams and roles.
+
+        Args:
+            email: User's email address.
+            name: User's display name.
+            teams_with_role: Sequence of (team_key, role_key) tuples assigning the user to teams with specific roles.
+
+        Returns:
+            The created user data.
         """
         return self._gql_client.create_user(
             input=UserCreate(
                 email=email,
                 name=name,
-                teams=[
-                    UserCreateTeamWithRole(team=team, role=role)
-                    for (team, role) in teams_with_role
-                ],
+                teams=[UserCreateTeamWithRole(team=team, role=role) for (team, role) in teams_with_role],
             )
         ).create_user
 
@@ -78,6 +82,11 @@ class Users(SyncAPIResource):  # type: ignore[misc]
         return self._gql_client.remove_team_member(input).remove_team_member
 
     def delete(self, email: str):
+        """Delete a user from the system.
+
+        Args:
+            email: The email address of the user to delete.
+        """
         self._gql_client.delete_user(email)
 
 
@@ -103,27 +112,28 @@ class AsyncUsers(AsyncAPIResource):  # type: ignore[misc]
         result = await self._gql_client.list_users()
         return result.users
 
-    async def create(
-        self, email: str, name: str, teams_with_role: Sequence[tuple[str, str]]
-    ) -> UserData:
+    async def create(self, email: str, name: str, teams_with_role: Sequence[tuple[str, str]]) -> UserData:
         """
-        Create a user and with preset teams and role
+        Create a user with preset teams and roles.
+
+        Args:
+            email: User's email address.
+            name: User's display name.
+            teams_with_role: Sequence of (team_key, role_key) tuples assigning the user to teams with specific roles.
+
+        Returns:
+            The created user data.
         """
         result = await self._gql_client.create_user(
             input=UserCreate(
                 email=email,
                 name=name,
-                teams=[
-                    UserCreateTeamWithRole(team=team, role=role)
-                    for (team, role) in teams_with_role
-                ],
+                teams=[UserCreateTeamWithRole(team=team, role=role) for (team, role) in teams_with_role],
             )
         )
         return result.create_user
 
-    async def add_to_team(
-        self, email: str, team: str, role: str
-    ) -> UpdateUserSetTeamMember:
+    async def add_to_team(self, email: str, team: str, role: str) -> UpdateUserSetTeamMember:
         """
         Update team and role for user.
 
@@ -149,4 +159,9 @@ class AsyncUsers(AsyncAPIResource):  # type: ignore[misc]
         return (await self._gql_client.remove_team_member(input)).remove_team_member
 
     async def delete(self, email: str):
+        """Delete a user from the system.
+
+        Args:
+            email: The email address of the user to delete.
+        """
         await self._gql_client.delete_user(email)

{adaptive_sdk-0.1.14.dist-info → adaptive_sdk-0.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adaptive-sdk
-Version: 0.1.14
+Version: 0.12.1
 Summary: Python SDK for Adaptive Engine
 Author-email: Vincent Debergue <vincent@adaptive-ml.com>, Joao Moura <joao@adaptive-ml.com>, Yacine Bouraoui <yacine@adaptive-ml.com>
 Requires-Python: >=3.10