cheshirecat-python-sdk 1.8.5__tar.gz → 1.8.6__tar.gz

{cheshirecat_python_sdk-1.8.5 → cheshirecat_python_sdk-1.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cheshirecat-python-sdk
-Version: 1.8.5
+Version: 1.8.6
 Summary: Python SDK for the Cloud-ready fork of the Cheshire Cat
 Project-URL: Repository, https://github.com/matteocacciola/cheshirecat-python-sdk
 Project-URL: Documentation, https://github.com/matteocacciola/cheshirecat-python-sdk#README

{cheshirecat_python_sdk-1.8.5 → cheshirecat_python_sdk-1.8.6}/cheshirecat_python_sdk/endpoints/users.py

@@ -59,10 +59,7 @@ class UsersEndpoint(AbstractEndpoint):
         response = self.get_http_client(agent_id).get(self.prefix)
         response.raise_for_status()
 
-        result = []
-        for item in response.json():
-            result.append(deserialize(item, UserOutput))
-        return result
+        return [deserialize(item, UserOutput) for item in response.json()]
 
     def get_user(self, user_id: str, agent_id: str) -> UserOutput:
         """

{cheshirecat_python_sdk-1.8.5 → cheshirecat_python_sdk-1.8.6}/cheshirecat_python_sdk/endpoints/utils.py

@@ -1,7 +1,13 @@
-from typing import List
+from typing import List, Dict
 
 from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
-from cheshirecat_python_sdk.models.api.admins import ResetOutput, ClonedOutput, CreatedOutput
+from cheshirecat_python_sdk.models.api.admins import (
+    ResetOutput,
+    AgentClonedOutput,
+    AgentCreatedOutput,
+    AgentOutput,
+    AgentUpdatedOutput,
+)
 from cheshirecat_python_sdk.utils import deserialize
 
 
@@ -17,28 +23,33 @@ class UtilsEndpoint(AbstractEndpoint):
         """
         return self.post_json(self.format_url("/factory/reset/"), self.system_id, output_class=ResetOutput)
 
-    def get_agents(self) -> List[str]:
+    def get_agents(self) -> List[AgentOutput]:
         """
         Get a list of all agents.
-        :return: List[str], the IDs of the agents.
+        :return: List[AgentOutput], the ID and the metadata of the agents.
         """
-        return self.get(self.format_url("/agents/"), self.system_id)
+        response = self.get_http_client(agent_id=self.system_id).get(self.format_url("/agents/"))
+        response.raise_for_status()
+
+        return [deserialize(item, AgentOutput) for item in response.json()]
 
-    def post_agent_create(self, agent_id: str) -> CreatedOutput:
+    def post_agent_create(self, agent_id: str, metadata: Dict | None = None) -> AgentCreatedOutput:
         """
         Create a new agent.
         :param agent_id: The ID of the agent.
-        :return: CreatedOutput, the details of the agent.
+        :param metadata: The metadata of the agent.
+        :return: AgentCreatedOutput, the details of the agent.
         """
-        response = self.get_http_client().post(
+        payload = {"agent_id": agent_id}
+        if metadata is not None:
+            payload["metadata"] = metadata  # type: ignore
+
+        return self.post_json(
             self.format_url("/agents/create/"),
-            json={
-                "agent_id": agent_id,
-            },
+            self.system_id,
+            output_class=AgentCreatedOutput,
+            payload=payload,
         )
-        response.raise_for_status()
-
-        return deserialize(response.json(), CreatedOutput)
 
     def post_agent_reset(self, agent_id: str) -> ResetOutput:
         """
@@ -56,16 +67,30 @@ class UtilsEndpoint(AbstractEndpoint):
         """
         return self.post_json(self.format_url("/agents/destroy/"), agent_id, output_class=ResetOutput)
 
-    def post_agent_clone(self, agent_id: str, new_agent_id: str) -> ClonedOutput:
+    def post_agent_clone(self, agent_id: str, new_agent_id: str) -> AgentClonedOutput:
         """
         Destroy an agent.
         :param agent_id: The ID of the agent.
         :param new_agent_id: The ID of the new cloned agent.
-        :return: ClonedOutput, the details of the cloning.
+        :return: AgentClonedOutput, the details of the cloning.
         """
         return self.post_json(
             self.format_url("/agents/clone/"),
             agent_id,
             payload={"agent_id": new_agent_id},
-            output_class=ClonedOutput
-        )
+            output_class=AgentClonedOutput,
+        )
+
+    def put_agent(self, agent_id: str, metadata: Dict) -> AgentUpdatedOutput:
+        """
+        Update the metadata of an agent.
+        :param agent_id: The ID of the agent.
+        :param metadata: The new metadata for the agent.
+        :return: AgentUpdatedOutput, the details of the update.
+        """
+        return self.put(
+            self.format_url("/agents/"),
+            agent_id,
+            payload={"metadata": metadata},
+            output_class=AgentUpdatedOutput,
+        )

{cheshirecat_python_sdk-1.8.5 → cheshirecat_python_sdk-1.8.6}/cheshirecat_python_sdk/models/api/admins.py

@@ -4,7 +4,7 @@ from pydantic import BaseModel
 from cheshirecat_python_sdk.models.api.plugins import PluginToggleOutput
 
 
-class CreatedOutput(BaseModel):
+class AgentCreatedOutput(BaseModel):
     created: bool
 
 
@@ -32,5 +32,14 @@ class ResetOutput(BaseModel):
     deleted_plugin_folders: bool
 
 
-class ClonedOutput(BaseModel):
+class AgentClonedOutput(BaseModel):
     cloned: bool = False
+
+
+class AgentUpdatedOutput(BaseModel):
+    updated: bool
+
+
+class AgentOutput(BaseModel):
+    agent_id: str
+    metadata: Dict

{cheshirecat_python_sdk-1.8.5 → cheshirecat_python_sdk-1.8.6}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "cheshirecat-python-sdk"
 description = "Python SDK for the Cloud-ready fork of the Cheshire Cat"
-version = "1.8.5"
+version = "1.8.6"
 requires-python = ">=3.10"
 license = { file = "LICENSE" }
 authors = [