slim-bindings 0.3.6__cp39-cp39-win_amd64.whl → 0.5.0__cp39-cp39-win_amd64.whl

slim_bindings/__init__.py

@@ -2,11 +2,14 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import asyncio
+import datetime
 from typing import Optional
 
 from ._slim_bindings import (  # type: ignore[attr-defined]
     SESSION_UNSPECIFIED,
-    PyAgentType,
+    PyIdentityProvider,
+    PyIdentityVerifier,
+    PyName,
     PyService,
     PySessionConfiguration,
     PySessionInfo,
@@ -21,6 +24,7 @@ from ._slim_bindings import (  # type: ignore[attr-defined]
     disconnect,
     get_default_session_config,
     get_session_config,
+    invite,
     publish,
     receive,
     remove_route,
@@ -32,6 +36,18 @@ from ._slim_bindings import (  # type: ignore[attr-defined]
     subscribe,
     unsubscribe,
 )
+from ._slim_bindings import (
+    PyAlgorithm as PyAlgorithm,
+)
+from ._slim_bindings import (
+    PyKey as PyKey,
+)
+from ._slim_bindings import (
+    PyKeyData as PyKeyData,
+)
+from ._slim_bindings import (
+    PyKeyFormat as PyKeyFormat,
+)
 from ._slim_bindings import (
     PySessionDirection as PySessionDirection,
 )
@@ -122,20 +138,18 @@ class Slim:
     def __init__(
         self,
         svc: PyService,
-        organization: str,
-        namespace: str,
-        agent: str,
+        name: PyName,
     ):
         """
         Initialize a new SLIM instance. A SLIM instance is associated with a single
-        local agent. The agent is identified by its organization, namespace, and name.
-        The agent ID is determined by the provided service (svc).
+        local app. The app is identified by its organization, namespace, and name.
+        The unique ID is determined by the provided service (svc).
 
         Args:
             svc (PyService): The Python service instance for SLIM.
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
+            organization (str): The organization of the app.
+            namespace (str): The namespace of the app.
+            app (str): The name of the app.
         """
 
         # Initialize service
@@ -147,8 +161,8 @@ class Slim:
         }
 
         # Save local names
-        self.local_name = PyAgentType(organization, namespace, agent)
-        self.local_id = self.svc.id
+        name.id = svc.id
+        self.local_name = name
 
         # Create connection ID map
         self.conn_ids: dict[str, int] = {}
@@ -197,42 +211,39 @@ class Slim:
     @classmethod
     async def new(
         cls,
-        organization: str,
-        namespace: str,
-        agent: str,
-        agent_id: Optional[int] = None,
+        name: PyName,
+        provider: PyIdentityProvider,
+        verifier: PyIdentityVerifier,
     ) -> "Slim":
         """
-        Create a new SLIM instance. A SLIM instamce is associated to one single
-        local agent. The agent is identified by its organization, namespace and name.
-        The agent ID is optional. If not provided, the agent will be created with a new ID.
+        Create a new SLIM instance. A SLIM instance is associated to one single
+        local app. The app is identified by its organization, namespace and name.
+        The app ID is optional. If not provided, the app will be created with a new ID.
 
         Args:
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            agent_id (int): The ID of the agent. If not provided, a new ID will be created.
+            organization (str): The organization of the app.
+            namespace (str): The namespace of the app.
+            app (str): The name of the app.
+            app_id (int): The ID of the app. If not provided, a new ID will be created.
 
         Returns:
             Slim: A new SLIM instance
         """
 
         return cls(
-            await create_pyservice(organization, namespace, agent, agent_id),
-            organization,
-            namespace,
-            agent,
+            await create_pyservice(name, provider, verifier),
+            name,
         )
 
-    def get_agent_id(self) -> int:
+    def get_id(self) -> int:
         """
-        Get the ID of the agent.
+        Get the ID of the app.
 
         Args:
             None
 
         Returns:
-            int: The ID of the agent.
+            int: The ID of the app.
         """
 
         return self.svc.id
@@ -416,7 +427,7 @@ class Slim:
         self.conn_id = conn_id
 
         # Subscribe to the local name
-        await subscribe(self.svc, conn_id, self.local_name, self.local_id)
+        await subscribe(self.svc, conn_id, self.local_name)
 
         # return the connection ID
         return conn_id
@@ -438,103 +449,79 @@ class Slim:
 
     async def set_route(
         self,
-        organization: str,
-        namespace: str,
-        agent: str,
-        id: Optional[int] = None,
+        name: PyName,
     ):
         """
         Set route for outgoing messages via the connected SLIM instance.
 
         Args:
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            id (int): Optional ID of the agent.
+            name (PyName): The name of the app or channel to route messages to.
 
         Returns:
             None
         """
 
-        name = PyAgentType(organization, namespace, agent)
-        await set_route(self.svc, self.conn_id, name, id)
+        await set_route(self.svc, self.conn_id, name)
 
     async def remove_route(
-        self, organization: str, namespace: str, agent: str, id: Optional[int] = None
+        self,
+        name: PyName,
     ):
         """
         Remove route for outgoing messages via the connected SLIM instance.
 
         Args:
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            id (int): Optional ID of the agent.
+            name (PyName): The name of the app or channel to remove the route for.
 
         Returns:
             None
         """
 
-        name = PyAgentType(organization, namespace, agent)
-        await remove_route(self.svc, self.conn_id, name, id)
+        await remove_route(self.svc, self.conn_id, name)
 
-    async def subscribe(
-        self, organization: str, namespace: str, agent: str, id: Optional[int] = None
-    ):
+    async def subscribe(self, name: PyName):
         """
-        Subscribe to receive messages for the given agent.
+        Subscribe to receive messages for the given name.
 
         Args:
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            id (int): Optional ID of the agent.
+            name (PyName): The name to subscribe to. This can be an app or a channel.
 
         Returns:
             None
         """
 
-        sub = PyAgentType(organization, namespace, agent)
-        await subscribe(self.svc, self.conn_id, sub, id)
+        await subscribe(self.svc, self.conn_id, name)
 
-    async def unsubscribe(
-        self, organization: str, namespace: str, agent: str, id: Optional[int] = None
-    ):
+    async def unsubscribe(self, name: PyName):
         """
-        Unsubscribe from receiving messages for the given agent.
+        Unsubscribe from receiving messages for the given name.
 
         Args:
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            id (int): Optional ID of the agent.
+            name (PyName): The name to unsubscribe from. This can be an app or a channel.
 
         Returns:
             None
         """
 
-        unsub = PyAgentType(organization, namespace, agent)
-        await unsubscribe(self.svc, self.conn_id, unsub, id)
+        await unsubscribe(self.svc, self.conn_id, name)
 
     async def publish(
         self,
         session: PySessionInfo,
         msg: bytes,
-        organization: str,
-        namespace: str,
-        agent: str,
-        agent_id: Optional[int] = None,
+        dest: PyName,
+        payload_type: Optional[str] = None,
+        metadata: Optional[dict] = None,
     ):
         """
-        Publish a message to an agent via normal matching in subscription table.
+        Publish a message to an app or channel via normal matching in subscription table.
 
         Args:
             session (PySessionInfo): The session information.
             msg (str): The message to publish.
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            agent_id (int): Optional ID of the agent.
+            dest (PyName): The destination name to publish the message to.
+            payload_type (str): The type of the message payload (optional)
+            metadata (dict): The metadata associated to the message (optional)
 
         Returns:
             None
@@ -544,28 +531,33 @@ class Slim:
         if session.id not in self.sessions:
             raise Exception("session not found", session.id)
 
-        dest = PyAgentType(organization, namespace, agent)
-        await publish(self.svc, session, 1, msg, dest, agent_id)
+        await publish(self.svc, session, 1, msg, dest, payload_type, metadata)
+
+    async def invite(
+        self,
+        session: PySessionInfo,
+        name: PyName,
+    ):
+        # Make sure the sessions exists
+        if session.id not in self.sessions:
+            raise Exception("session not found", session.id)
+
+        await invite(self.svc, session, name)
 
     async def request_reply(
         self,
         session: PySessionInfo,
         msg: bytes,
-        organization: str,
-        namespace: str,
-        agent: str,
-        agent_id: Optional[int] = None,
+        dest: PyName,
+        timeout: Optional[datetime.timedelta] = None,
     ) -> tuple[PySessionInfo, Optional[bytes]]:
         """
         Publish a message and wait for the first response.
 
         Args:
-            msg (str): The message to publish.
             session (PySessionInfo): The session information.
-            organization (str): The organization of the agent.
-            namespace (str): The namespace of the agent.
-            agent (str): The name of the agent.
-            agent_id (int): Optional ID of the agent.
+            msg (str): The message to publish.
+            dest (PyName): The destination name to publish the message to.
 
         Returns:
             tuple: The PySessionInfo and the message.
@@ -575,18 +567,28 @@ class Slim:
         if session.id not in self.sessions:
             raise Exception("Session ID not found")
 
-        dest = PyAgentType(organization, namespace, agent)
-        await publish(self.svc, session, 1, msg, dest, agent_id)
+        await publish(self.svc, session, 1, msg, dest)
 
-        # Wait for a reply in the corresponding session queue
-        session_info, message = await self.receive(session.id)
+        # Wait for a reply in the corresponding session queue with timeout
+        if timeout is not None:
+            session_info, message = await asyncio.wait_for(
+                self.receive(session.id), timeout=timeout.total_seconds()
+            )
+        else:
+            session_info, message = await self.receive(session.id)
 
         return session_info, message
 
-    async def publish_to(self, session, msg):
+    async def publish_to(
+        self,
+        session: PySessionInfo,
+        msg: bytes,
+        payload_type: Optional[str] = None,
+        metadata: Optional[dict] = None,
+    ):
         """
-        Publish a message back to the agent that sent it.
-        The information regarding the source agent is stored in the session.
+        Publish a message back to the application that sent it.
+        The information regarding the source app is stored in the session.
 
         Args:
             session (PySessionInfo): The session information.
@@ -596,7 +598,9 @@ class Slim:
             None
         """
 
-        await publish(self.svc, session, 1, msg)
+        await publish(
+            self.svc, session, 1, msg, payload_type=payload_type, metadata=metadata
+        )
 
     async def receive(
         self, session: Optional[int] = None
@@ -623,7 +627,7 @@ class Slim:
         else:
             # Check if the session ID is in the sessions map
             if session not in self.sessions:
-                raise Exception("Session ID not found")
+                raise Exception(f"Session ID not found: {session}")
 
             # Get the queue for the session
             queue = self.sessions[session][1]

slim_bindings/_slim_bindings.pyi

@@ -5,31 +5,83 @@ import builtins
 import typing
 from enum import Enum, auto
 
-class PyAgentType:
-    r"""
-    agent class
-    """
-    organization: builtins.str
-    namespace: builtins.str
-    agent_type: builtins.str
-    def __new__(cls,agent_org:builtins.str, agent_ns:builtins.str, agent_class:builtins.str): ...
+class PyKey:
+    algorithm: PyAlgorithm
+    format: PyKeyFormat
+    key: PyKeyData
+    def __new__(cls,algorithm:PyAlgorithm, format:PyKeyFormat, key:PyKeyData): ...
 
-class PyRequestResponseConfiguration:
+class PyName:
     r"""
-    request response session config
+    name class
     """
-    ...
+    id: builtins.int
+    def __new__(cls,component0:builtins.str, component1:builtins.str, component2:builtins.str, id:typing.Optional[builtins.int]=None): ...
+    def set_id(self, id:builtins.int) -> None:
+        ...
+
+    def components(self) -> builtins.list[builtins.int]:
+        ...
+
+    def components_strings(self) -> builtins.list[builtins.str]:
+        ...
+
+    def equal_without_id(self, name:PyName) -> builtins.bool:
+        ...
+
+    def __repr__(self) -> builtins.str:
+        ...
+
+    def __str__(self) -> builtins.str:
+        ...
+
 
 class PyService:
     id: builtins.int
+    name: PyName
 
 class PySessionInfo:
     id: builtins.int
+    source_name: PyName
+    destination_name: PyName
+    payload_type: builtins.str
+    metadata: builtins.dict[builtins.str, builtins.str]
     def __new__(cls,session_id:builtins.int): ...
 
+class PyAlgorithm(Enum):
+    HS256 = auto()
+    HS384 = auto()
+    HS512 = auto()
+    RS256 = auto()
+    RS384 = auto()
+    RS512 = auto()
+    PS256 = auto()
+    PS384 = auto()
+    PS512 = auto()
+    ES256 = auto()
+    ES384 = auto()
+    EdDSA = auto()
+
+class PyIdentityProvider(Enum):
+    StaticJwt = auto()
+    Jwt = auto()
+    SharedSecret = auto()
+
+class PyIdentityVerifier(Enum):
+    Jwt = auto()
+    SharedSecret = auto()
+
+class PyKeyData(Enum):
+    File = auto()
+    Content = auto()
+
+class PyKeyFormat(Enum):
+    Pem = auto()
+    Jwk = auto()
+    Jwks = auto()
+
 class PySessionConfiguration(Enum):
     FireAndForget = auto()
-    RequestResponse = auto()
     Streaming = auto()
 
 class PySessionDirection(Enum):
@@ -45,13 +97,12 @@ class PySessionType(Enum):
     session type
     """
     FIRE_AND_FORGET = auto()
-    REQUEST_RESPONSE = auto()
     STREAMING = auto()
 
 def connect(svc:PyService, config:dict) -> typing.Any:
     ...
 
-def create_pyservice(organization:builtins.str, namespace:builtins.str, agent_type:builtins.str, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def create_pyservice(name:PyName, provider:PyIdentityProvider, verifier:PyIdentityVerifier) -> typing.Any:
     ...
 
 def create_session(svc:PyService, config:PySessionConfiguration) -> typing.Any:
@@ -72,13 +123,19 @@ def get_session_config(svc:PyService, session_id:builtins.int) -> typing.Any:
 def init_tracing(config:dict) -> typing.Any:
     ...
 
-def publish(svc:PyService, session_info:PySessionInfo, fanout:builtins.int, blob:typing.Sequence[builtins.int], name:typing.Optional[PyAgentType]=None, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def invite(svc:PyService, session_info:PySessionInfo, name:PyName) -> typing.Any:
+    ...
+
+def publish(svc:PyService, session_info:PySessionInfo, fanout:builtins.int, blob:typing.Sequence[builtins.int], name:typing.Optional[PyName]=None, payload_type:typing.Optional[builtins.str]=None, metadata:typing.Optional[typing.Mapping[builtins.str, builtins.str]]=None) -> typing.Any:
     ...
 
 def receive(svc:PyService) -> typing.Any:
     ...
 
-def remove_route(svc:PyService, conn:builtins.int, name:PyAgentType, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def remove(svc:PyService, session_info:PySessionInfo, name:PyName) -> typing.Any:
+    ...
+
+def remove_route(svc:PyService, conn:builtins.int, name:PyName) -> typing.Any:
     ...
 
 def run_server(svc:PyService, config:dict) -> typing.Any:
@@ -87,7 +144,7 @@ def run_server(svc:PyService, config:dict) -> typing.Any:
 def set_default_session_config(svc:PyService, config:PySessionConfiguration) -> typing.Any:
     ...
 
-def set_route(svc:PyService, conn:builtins.int, name:PyAgentType, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def set_route(svc:PyService, conn:builtins.int, name:PyName) -> typing.Any:
     ...
 
 def set_session_config(svc:PyService, session_id:builtins.int, config:PySessionConfiguration) -> typing.Any:
@@ -96,9 +153,9 @@ def set_session_config(svc:PyService, session_id:builtins.int, config:PySessionC
 def stop_server(svc:PyService, endpoint:builtins.str) -> typing.Any:
     ...
 
-def subscribe(svc:PyService, conn:builtins.int, name:PyAgentType, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def subscribe(svc:PyService, conn:builtins.int, name:PyName) -> typing.Any:
     ...
 
-def unsubscribe(svc:PyService, conn:builtins.int, name:PyAgentType, id:typing.Optional[builtins.int]=None) -> typing.Any:
+def unsubscribe(svc:PyService, conn:builtins.int, name:PyName) -> typing.Any:
     ...
 

slim_bindings-0.5.0.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: slim-bindings
+Version: 0.5.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Summary: SLIM Rust bindings for Python
+License-Expression: Apache-2.0
+Requires-Python: >=3.9, <4.0
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/agntcy/slim
+Project-URL: Issues, https://github.com/agntcy/slim/issues
+Project-URL: Changelog, https://github.com/agntcy/slim/blob/main/data-plane/python/bindings/CHANGELOG.md
+
+# SLIM Python Bindings
+
+Bindings to call the SLIM APIs from a python program.
+
+## Installation
+
+```bash
+pip install slim-bindings
+```
+
+## Include as dependency
+
+### With pyproject.toml
+
+```toml
+[project]
+name = "slim-example"
+version = "0.1.0"
+description = "Python program using SLIM"
+requires-python = ">=3.9"
+dependencies = [
+    "slim-bindings>=0.5.0"
+]
+```
+
+### With poetry project
+
+```toml
+[tool.poetry]
+name = "slim-example"
+version = "0.1.0"
+description = "Python program using SLIM"
+
+[tool.poetry.dependencies]
+python = ">=3.9,<3.14"
+slim-bindings = ">=0.5.0"
+```
+
+## Example programs
+
+Example apps can be found in the [repo](https://github.com/agntcy/slim/tree/slim-v0.5.0/data-plane/python/bindings/examples)
+

slim_bindings-0.5.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+slim_bindings-0.5.0.dist-info/METADATA,sha256=uRIm8DSwy6JKebHed40-v54TE3SATqY-rdxgXDlXSDY,1604
+slim_bindings-0.5.0.dist-info/WHEEL,sha256=nXnbksKtHhahczd7ttWN6X6HjQgLPILVWf_tYUzg9Pc,94
+slim_bindings/__init__.py,sha256=rbznLnV8PkidmL85t-CjH8goHZdk6u5dSRKQSFfSKyY,21082
+slim_bindings/_slim_bindings.cp39-win_amd64.pyd,sha256=234IYkgxBYD9130bc1gavIi30ZkMSnC7okd3qbWNgRE,20799488
+slim_bindings/_slim_bindings.pyi,sha256=xtYt9BVXAom8fNOUAwnYhRExECor_7IpRekM1SSwuX4,4166
+slim_bindings-0.5.0.dist-info/RECORD,,

{slim_bindings-0.3.6.dist-info → slim_bindings-0.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.2)
+Generator: maturin (1.9.4)
 Root-Is-Purelib: false
 Tag: cp39-cp39-win_amd64