naeural-client 2.0.2__tar.gz → 2.1.0__tar.gz

{naeural_client-2.0.2 → naeural_client-2.1.0}/.devcontainer/Dockerfile

@@ -10,6 +10,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     build-essential \
     libffi-dev \
     libssl-dev \
+    git \
     && rm -rf /var/lib/apt/lists/*
 
 # Install the SDK requirements

{naeural_client-2.0.2 → naeural_client-2.1.0}/.devcontainer/devcontainer.json

@@ -1,8 +1,9 @@
 {
-  "name" : "Naeural SDK Development Container",
+  "name" : "Naeural Edge Protocol SDK Development Container",
   "dockerFile" : "Dockerfile",
   // "image": "aidamian/image:tag",
 
+  
   "runArgs": [
     //"--gpus=all",
     "--hostname",

{naeural_client-2.0.2 → naeural_client-2.1.0}/.gitignore

@@ -171,7 +171,6 @@ blur_debugger/blur_debugger_draw__BLUR_DEBUGGER_DRAW_STEP__Tracking/
 
 *.ths
 
-.vscode
 .pypirc
 
 personal

naeural_client-2.1.0/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: File",
+      "type": "python",
+      "request": "launch",
+      "program": "${file}",
+      "justMyCode": true,
+
+      "console": "integratedTerminal",
+      "pythonArgs": ["-i"]
+  }
+  ]
+}

{naeural_client-2.0.2 → naeural_client-2.1.0}/LICENSE

@@ -186,7 +186,6 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Naeural.AI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{naeural_client-2.0.2 → naeural_client-2.1.0}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.0.2
-Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol framework
-Project-URL: Homepage, https://github.com/NaeuralEdgeProtocol/naeural_client
-Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues
+Version: 2.1.0
+Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
+Project-URL: Homepage, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client
+Project-URL: Bug Tracker, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client/issues
 Author-email: Stefan Saraev <saraevstefan@gmail.com>, Andrei Ionut Damian <andrei.damian@me.com>, Cristan Bleotiu <cristibleotiu@gmail.com>
-License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
@@ -21,7 +20,7 @@ Description-Content-Type: text/markdown
 
 # naeural_client SDK
 
-This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Execution Engine processing nodes ecosystem. For further information please see [Naeural AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
+This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural Edge Protocol network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Edge Protocol Execution Engine processing nodes ecosystem. For further information please see [Naeural Edge Protocol AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
 
 ## Dependencies
 
@@ -337,9 +336,9 @@ For any inquiries related to the funding and its impact on this project, please
 ```bibtex
 @misc{naeural_client,
   author = {Stefan Saraev, Andrei Damian},
-  title = {naeural_client: Python SDK for Naeural Edge Protocol},
+  title = {naeural_client: Python SDK for Naeural Edge Protocol Edge Protocol},
   year = {2024},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/naeural_client}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client}},
 }
 ```
 
@@ -348,7 +347,7 @@ For any inquiries related to the funding and its impact on this project, please
   author       = {Damian, Bleotiu, Saraev, Constantinescu},
   title        = {SOLIS – Sistem Omogen multi-Locație cu funcționalități Inteligente și Sustenabile”
 SMIS 143488},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/}},
   note         = {This project includes open-source components developed with support from the Romanian Competitiveness Operational Programme under grants SMIS 143488. The content is solely the responsibility of the authors and does not necessarily reflect the views of the funding agencies.},
   year         = {2021-2022}
 }
@@ -358,7 +357,7 @@ SMIS 143488},
 @misc{project_funding_acknowledgment2,
   author       = {Damian, Bleotiu, Saraev, Constantinescu, Milik, Lupaescu},
   title        = {ReDeN – Rețea Descentralizată Neurală SMIS 156084},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/}},
   note         = {This project includes open-source components developed with support from the Romanian Competitiveness Operational Programme under grants SMIS 143488. The content is solely the responsibility of the authors and does not necessarily reflect the views of the funding agencies.},
   year         = {2023-2024}
 }

{naeural_client-2.0.2 → naeural_client-2.1.0}/README.md

@@ -1,6 +1,6 @@
 # naeural_client SDK
 
-This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Execution Engine processing nodes ecosystem. For further information please see [Naeural AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
+This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural Edge Protocol network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Edge Protocol Execution Engine processing nodes ecosystem. For further information please see [Naeural Edge Protocol AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
 
 ## Dependencies
 
@@ -316,9 +316,9 @@ For any inquiries related to the funding and its impact on this project, please
 ```bibtex
 @misc{naeural_client,
   author = {Stefan Saraev, Andrei Damian},
-  title = {naeural_client: Python SDK for Naeural Edge Protocol},
+  title = {naeural_client: Python SDK for Naeural Edge Protocol Edge Protocol},
   year = {2024},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/naeural_client}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client}},
 }
 ```
 
@@ -327,7 +327,7 @@ For any inquiries related to the funding and its impact on this project, please
   author       = {Damian, Bleotiu, Saraev, Constantinescu},
   title        = {SOLIS – Sistem Omogen multi-Locație cu funcționalități Inteligente și Sustenabile”
 SMIS 143488},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/}},
   note         = {This project includes open-source components developed with support from the Romanian Competitiveness Operational Programme under grants SMIS 143488. The content is solely the responsibility of the authors and does not necessarily reflect the views of the funding agencies.},
   year         = {2021-2022}
 }
@@ -337,7 +337,7 @@ SMIS 143488},
 @misc{project_funding_acknowledgment2,
   author       = {Damian, Bleotiu, Saraev, Constantinescu, Milik, Lupaescu},
   title        = {ReDeN – Rețea Descentralizată Neurală SMIS 156084},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/}},
+  howpublished = {\url{https://github.com/Naeural Edge ProtocolEdgeProtocol/}},
   note         = {This project includes open-source components developed with support from the Romanian Competitiveness Operational Programme under grants SMIS 143488. The content is solely the responsibility of the authors and does not necessarily reflect the views of the funding agencies.},
   year         = {2023-2024}
 }

{naeural_client-2.0.2 → naeural_client-2.1.0}/TODOs.md

@@ -9,4 +9,4 @@ Secondary:
 
 - session method to get list of all online nodes from supervisor
 
-- change DecentrAIObject to NaeuralObject
+- change DecentrAIObject to Naeural Edge ProtocolObject

{naeural_client-2.0.2 → naeural_client-2.1.0}/__init__.py

@@ -9,3 +9,6 @@ from .naeural_client import load_dotenv
 from .naeural_client import __version__
 from .naeural_client import BaseDecentrAIObject, _PluginsManagerMixin, Logger
 from .naeural_client import BaseCodeChecker
+from .naeural_client import PLUGIN_SIGNATURES
+from .naeural_client import PLUGIN_TYPES
+

{naeural_client-2.0.2 → naeural_client-2.1.0}/naeural_client/__init__.py

@@ -11,3 +11,5 @@ from .base_decentra_object import BaseDecentrAIObject
 from .plugins_manager_mixin import _PluginsManagerMixin
 from .logging import Logger
 from .code_cheker import BaseCodeChecker
+from .const import PLUGIN_SIGNATURES
+from .default.instance import PLUGIN_TYPES

{naeural_client-2.0.2 → naeural_client-2.1.0}/naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.0.2"
+__VER__ = "2.1.0"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

{naeural_client-2.0.2 → naeural_client-2.1.0}/naeural_client/base/generic_session.py

@@ -9,7 +9,7 @@ from time import time as tm
 
 from ..base_decentra_object import BaseDecentrAIObject
 from ..bc import DefaultBlockEngine
-from ..const import COMMANDS, ENVIRONMENT, HB, PAYLOAD_DATA, STATUS_TYPE
+from ..const import COMMANDS, ENVIRONMENT, HB, PAYLOAD_DATA, STATUS_TYPE, PLUGIN_SIGNATURES
 from ..const import comms as comm_ct
 from ..io_formatter import IOFormatterWrapper
 from ..logging import Logger
@@ -23,7 +23,7 @@ from .transaction import Transaction
 
 class GenericSession(BaseDecentrAIObject):
   """
-  A Session is a connection to a communication server which provides the channel to interact with nodes from the Naeural network.
+  A Session is a connection to a communication server which provides the channel to interact with nodes from the Naeural Edge Protocol network.
   A Session manages `Pipelines` and handles all messages received from the communication server.
   The Session handles all callbacks that are user-defined and passed as arguments in the API calls.
   """
@@ -74,7 +74,7 @@ class GenericSession(BaseDecentrAIObject):
                root_topic="naeural",
                **kwargs) -> None:
     """
-    A Session is a connection to a communication server which provides the channel to interact with nodes from the Naeural network.
+    A Session is a connection to a communication server which provides the channel to interact with nodes from the Naeural Edge Protocol network.
     A Session manages `Pipelines` and handles all messages received from the communication server.
     The Session handles all callbacks that are user-defined and passed as arguments in the API calls.
 
@@ -91,8 +91,8 @@ class GenericSession(BaseDecentrAIObject):
     secured: bool, optional
         True if connection is secured, by default None
     name : str, optional
-        The name of this connection, used to identify owned pipelines on a specific Naeural edge node.
-        The name will be used as `INITIATOR_ID` and `SESSION_ID` when communicating with Naeural edge nodes, by default 'pySDK'
+        The name of this connection, used to identify owned pipelines on a specific Naeural Edge Protocol edge node.
+        The name will be used as `INITIATOR_ID` and `SESSION_ID` when communicating with Naeural Edge Protocol edge nodes, by default 'pySDK'
     config : dict, optional
         Configures the names of the channels this session will connect to.
         If using a Mqtt server, these channels are in fact topics.
@@ -102,7 +102,7 @@ class GenericSession(BaseDecentrAIObject):
         If set, process the messages that come only from the nodes from this list.
         Defaults to None
     show_commands : bool
-        If True, will print the commands that are being sent to the Naeural edge nodes.
+        If True, will print the commands that are being sent to the Naeural Edge Protocol edge nodes.
         Defaults to False
     log : Logger, optional
         A logger object which implements basic logging functionality and some other utils stuff. Can be ignored for now.
@@ -335,7 +335,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
 
       Returns
       -------
@@ -351,7 +351,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
       """
       self._dct_node_last_seen_time[node_addr] = tm()
       self._dct_node_addr_name[node_addr] = node_id
@@ -364,7 +364,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
       dict_msg : dict
           The message received from the communication server.
       """
@@ -383,7 +383,7 @@ class GenericSession(BaseDecentrAIObject):
       dict_msg : dict
           The message received from the communication server
       msg_node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
       msg_pipeline : str
           The name of the pipeline that sent the message.
       msg_signature : str
@@ -449,7 +449,7 @@ class GenericSession(BaseDecentrAIObject):
       dict_msg : dict
           The message received from the communication server
       msg_node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
       msg_pipeline : str
           The name of the pipeline that sent the message.
       msg_signature : str
@@ -509,7 +509,7 @@ class GenericSession(BaseDecentrAIObject):
       dict_msg : dict
           The message received from the communication server
       msg_node_addr : str
-          The address of the Naeural edge node that sent the message.
+          The address of the Naeural Edge Protocol edge node that sent the message.
       msg_pipeline : str
           The name of the pipeline that sent the message.
       msg_signature : str
@@ -538,7 +538,14 @@ class GenericSession(BaseDecentrAIObject):
       for transaction in open_transactions_copy:
         transaction.handle_payload(dict_msg)
       if self.custom_on_payload is not None:
-        self.custom_on_payload(self, msg_node_addr, msg_pipeline, msg_signature, msg_instance, Payload(msg_data))
+        self.custom_on_payload(
+          self,  # session
+          msg_node_addr,    # node_addr
+          msg_pipeline,     # pipeline
+          msg_signature,    # plugin signature
+          msg_instance,     # plugin instance name
+          Payload(msg_data) # the actual payload
+        )
 
       return
 
@@ -662,7 +669,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       to : str
-          The name of the Naeural edge node that will receive the payload.
+          The name of the Naeural Edge Protocol edge node that will receive the payload.
       payload : dict
           The payload to send.
       """
@@ -808,13 +815,14 @@ class GenericSession(BaseDecentrAIObject):
         os.getenv(ENVIRONMENT.AIXP_USER),
         os.getenv(ENVIRONMENT.EE_USERNAME),
         os.getenv(ENVIRONMENT.EE_USER),
+        os.getenv(ENVIRONMENT.EE_MQTT_USER),
         self._config.get(comm_ct.USER),
       ]
 
       user = next((x for x in possible_user_values if x is not None), None)
 
       if user is None:
-        env_error = "Error: No user specified for Naeural network connection. Please make sure you have the correct credentials in the environment variables within the .env file or provide them as params in code (not recommended due to potential security issue)."
+        env_error = "Error: No user specified for Naeural Edge Protocol network connection. Please make sure you have the correct credentials in the environment variables within the .env file or provide them as params in code (not recommended due to potential security issue)."
         raise ValueError(env_error)
       if self._config.get(comm_ct.USER, None) is None:
         self._config[comm_ct.USER] = user
@@ -827,13 +835,14 @@ class GenericSession(BaseDecentrAIObject):
         os.getenv(ENVIRONMENT.EE_PASSWORD),
         os.getenv(ENVIRONMENT.EE_PASS),
         os.getenv(ENVIRONMENT.EE_PWD),
+        os.getenv(ENVIRONMENT.EE_MQTT),
         self._config.get(comm_ct.PASS),
       ]
 
       pwd = next((x for x in possible_password_values if x is not None), None)
 
       if pwd is None:
-        raise ValueError("Error: No password specified for Naeural network connection")
+        raise ValueError("Error: No password specified for Naeural Edge Protocol network connection")
       if self._config.get(comm_ct.PASS, None) is None:
         self._config[comm_ct.PASS] = pwd
 
@@ -843,6 +852,7 @@ class GenericSession(BaseDecentrAIObject):
         os.getenv(ENVIRONMENT.AIXP_HOST),
         os.getenv(ENVIRONMENT.EE_HOSTNAME),
         os.getenv(ENVIRONMENT.EE_HOST),
+        os.getenv(ENVIRONMENT.EE_MQTT_HOST),
         self._config.get(comm_ct.HOST),
         "r9092118.ala.eu-central-1.emqxsl.com",
       ]
@@ -850,7 +860,7 @@ class GenericSession(BaseDecentrAIObject):
       host = next((x for x in possible_host_values if x is not None), None)
 
       if host is None:
-        raise ValueError("Error: No host specified for Naeural network connection")
+        raise ValueError("Error: No host specified for Naeural Edge Protocol network connection")
       if self._config.get(comm_ct.HOST, None) is None:
         self._config[comm_ct.HOST] = host
 
@@ -858,6 +868,7 @@ class GenericSession(BaseDecentrAIObject):
         port,
         os.getenv(ENVIRONMENT.AIXP_PORT),
         os.getenv(ENVIRONMENT.EE_PORT),
+        os.getenv(ENVIRONMENT.EE_MQTT_PORT),
         self._config.get(comm_ct.PORT),
         8883,
       ]
@@ -865,7 +876,7 @@ class GenericSession(BaseDecentrAIObject):
       port = next((x for x in possible_port_values if x is not None), None)
 
       if port is None:
-        raise ValueError("Error: No port specified for Naeural network connection")
+        raise ValueError("Error: No port specified for Naeural Edge Protocol network connection")
       if self._config.get(comm_ct.PORT, None) is None:
         self._config[comm_ct.PORT] = int(port)
 
@@ -920,7 +931,7 @@ class GenericSession(BaseDecentrAIObject):
       command : str
           The command to send.
       worker : str
-          The name of the Naeural edge node that will receive the command.
+          The name of the Naeural Edge Protocol edge node that will receive the command.
       payload : dict
           The payload to send.
       show_command : bool, optional
@@ -1134,7 +1145,7 @@ class GenericSession(BaseDecentrAIObject):
                         max_wait_time=0,
                         **kwargs) -> Pipeline:
       """
-      Create a new pipeline on a node. A pipeline is the equivalent of the "config file" used by the Naeural edge node team internally.
+      Create a new pipeline on a node. A pipeline is the equivalent of the "config file" used by the Naeural Edge Protocol edge node team internally.
 
       A `Pipeline` is a an object that encapsulates a one-to-many, data acquisition to data processing, flow of data.
 
@@ -1150,14 +1161,14 @@ class GenericSession(BaseDecentrAIObject):
 
         `Plugin` == `Signature`
 
-      This call can busy-wait for a number of seconds to listen to heartbeats, in order to check if an Naeural edge node is online or not.
+      This call can busy-wait for a number of seconds to listen to heartbeats, in order to check if an Naeural Edge Protocol edge node is online or not.
       If the node does not appear online, a warning will be displayed at the stdout, telling the user that the message that handles the
       creation of the pipeline will be sent, but it is not guaranteed that the specific node will receive it.
 
       Parameters
       ----------
       node : str
-          Address or Name of the Naeural edge node that will handle this pipeline.
+          Address or Name of the Naeural Edge Protocol edge node that will handle this pipeline.
       name : str
           Name of the pipeline. This is good to be kept unique, as it allows multiple parties to overwrite each others configurations.
       data_source : str, optional
@@ -1233,36 +1244,36 @@ class GenericSession(BaseDecentrAIObject):
 
     def get_active_nodes(self):
       """
-      Get the list of all Naeural edge nodes that sent a message since this session was created, and that are considered online
+      Get the list of all Naeural Edge Protocol edge nodes that sent a message since this session was created, and that are considered online
 
       Returns
       -------
       list
-          List of names of all the Naeural edge nodes that are considered online
+          List of names of all the Naeural Edge Protocol edge nodes that are considered online
 
       """
       return [k for k, v in self._dct_node_last_seen_time.items() if tm() - v < self.online_timeout]
 
     def get_allowed_nodes(self):
       """
-      Get the list of all active Naeural edge nodes to whom this session can send messages
+      Get the list of all active Naeural Edge Protocol edge nodes to whom this session can send messages
 
       Returns
       -------
       list[str]
-          List of names of all the active Naeural edge nodes to whom this session can send messages
+          List of names of all the active Naeural Edge Protocol edge nodes to whom this session can send messages
       """
       active_nodes = self.get_active_nodes()
       return [node for node in self._dct_can_send_to_node if self._dct_can_send_to_node[node] and node in active_nodes]
 
     def get_active_pipelines(self, node):
       """
-      Get a dictionary with all the pipelines that are active on this Naeural edge node
+      Get a dictionary with all the pipelines that are active on this Naeural Edge Protocol edge node
 
       Parameters
       ----------
       node : str
-          Address or Name of the Naeural edge node
+          Address or Name of the Naeural Edge Protocol edge node
 
       Returns
       -------
@@ -1302,7 +1313,7 @@ class GenericSession(BaseDecentrAIObject):
                            on_notification=None,
                            max_wait_time=0) -> Pipeline:
       """
-      Create a Pipeline object and attach to an existing pipeline on an Naeural edge node.
+      Create a Pipeline object and attach to an existing pipeline on an Naeural Edge Protocol edge node.
       Useful when one wants to treat an existing pipeline as one of his own,
       or when one wants to attach callbacks to various events (on_data, on_notification).
 
@@ -1320,7 +1331,7 @@ class GenericSession(BaseDecentrAIObject):
 
         `Plugin` == `Signature`
 
-      This call can busy-wait for a number of seconds to listen to heartbeats, in order to check if an Naeural edge node is online or not.
+      This call can busy-wait for a number of seconds to listen to heartbeats, in order to check if an Naeural Edge Protocol edge node is online or not.
       If the node does not appear online, a warning will be displayed at the stdout, telling the user that the message that handles the
       creation of the pipeline will be sent, but it is not guaranteed that the specific node will receive it.
 
@@ -1328,7 +1339,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node : str
-          Address or Name of the Naeural edge node that handles this pipeline.
+          Address or Name of the Naeural Edge Protocol edge node that handles this pipeline.
       name : str
           Name of the existing pipeline.
       on_data : Callable[[Pipeline, str, str, dict], None], optional
@@ -1385,7 +1396,7 @@ class GenericSession(BaseDecentrAIObject):
     def create_or_attach_to_pipeline(self, *,
                                      node,
                                      name,
-                                     data_source,
+                                     data_source="Void",
                                      config={},
                                      plugins=[],
                                      on_data=None,
@@ -1393,21 +1404,27 @@ class GenericSession(BaseDecentrAIObject):
                                      max_wait_time=0,
                                      **kwargs) -> Pipeline:
       """
-      Create a new pipeline on a node, or attach to an existing pipeline on an Naeural edge node.
+      Create a new pipeline on a node, or attach to an existing pipeline on an Naeural Edge Protocol edge node.
 
       Parameters
       ----------
       node : str
-          Address or Name of the Naeural edge node that will handle this pipeline.
+          Address or Name of the Naeural Edge Protocol edge node that will handle this pipeline.
+          
       name : str
           Name of the pipeline. This is good to be kept unique, as it allows multiple parties to overwrite each others configurations.
+          
       data_source : str
           This is the name of the DCT plugin, which resembles the desired functionality of the acquisition.
+          Defaults to "Void" - no actual data acquisition.
+          
       config : dict, optional
           This is the dictionary that contains the configuration of the acquisition source, by default {}
+          
       plugins : list
           List of dictionaries which contain the configurations of each plugin instance that is desired to run on the box. 
           Defaults to []. Should be left [], and instances should be created with the api.
+          
       on_data : Callable[[Pipeline, str, str, dict], None], optional
           Callback that handles messages received from any plugin instance. 
           As arguments, it has a reference to this Pipeline object, the signature and the instance of the plugin
@@ -1415,15 +1432,18 @@ class GenericSession(BaseDecentrAIObject):
           This callback acts as a default payload processor and will be called even if for a given instance
           the user has defined a specific callback.
           Defaults to None.
+          
       on_notification : Callable[[Pipeline, dict], None], optional
           Callback that handles notifications received from any plugin instance. 
           As arguments, it has a reference to this Pipeline object, along with the payload itself. 
           This callback acts as a default payload processor and will be called even if for a given instance
           the user has defined a specific callback.
           Defaults to None.
+          
       max_wait_time : int, optional
           The maximum time to busy-wait, allowing the Session object to listen to node heartbeats
           and to check if the desired node is online in the network, by default 0.
+          
       **kwargs :
           The user can provide the configuration of the acquisition source directly as kwargs.
 
@@ -1552,7 +1572,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node : str
-          The address or name of the Naeural edge node.
+          The address or name of the Naeural Edge Protocol edge node.
       timeout : int, optional
           The timeout, by default 15
 
@@ -1586,7 +1606,7 @@ class GenericSession(BaseDecentrAIObject):
       Parameters
       ----------
       node : str
-          The address or name of the Naeural edge node.
+          The address or name of the Naeural Edge Protocol edge node.
 
       Returns
       -------
@@ -1640,15 +1660,39 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature="CUSTOM_CODE_FASTAPI_01",
+      signature=PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01,
       endpoints=None,
       use_ngrok=True,
       **kwargs
     ):
+      """
+      Create a new web app on a node.
+      
+      Parameters
+      ----------
+      
+      node : str
+          Address or Name of the Naeural Edge Protocol edge node that will handle this web app.
+          
+      name : str
+          Name of the web app.
+          
+      signature : str, optional
+          The signature of the plugin that will be used. Defaults to PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01.
+          
+      endpoints : list[dict], optional
+          A list of dictionaries defining the endpoint configuration. Defaults to None.
+          
+      use_ngrok : bool, optional
+          If True, will use ngrok to expose the web app. Defaults to True.
+          
+      
+      """
 
       pipeline: Pipeline = self.create_pipeline(
         node=node,
         name=name,
+        # default TYPE is "Void"
       )
 
       instance = pipeline.create_plugin_instance(
@@ -1666,6 +1710,43 @@ class GenericSession(BaseDecentrAIObject):
       # end if we have endpoints defined in the call
 
       return pipeline, instance
+    
+
+    def create_telegram_simple_bot(
+      self,
+      *,
+      node,
+      name,
+      signature=PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01,
+      message_handler=None,
+      telegram_bot_token=None,
+      telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY,
+      **kwargs
+    ):
+      
+      if telegram_bot_token is None:
+        telegram_bot_token = os.getenv(telegram_bot_token_env_key)
+        if telegram_bot_token is None:
+          message = f"Warning! No Telegram bot token provided as via env {ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY} or explicitly as `telegram_bot_token` param."
+          raise ValueError(message)
+      
+      b64code = self._get_base64_code(message_handler)
+
+      pipeline: Pipeline = self.create_pipeline(
+        node=node,
+        name=name,
+        # default TYPE is "Void"
+      )
+
+      instance = pipeline.create_plugin_instance(
+        signature=signature,
+        instance_id=self.log.get_unique_id(),
+        telegram_bot_token=telegram_bot_token,
+        message_handler=b64code,
+        **kwargs
+      )      
+      return pipeline, instance
+    
 
     def broadcast_instance_command_and_wait_for_response_payload(
       self,

{naeural_client-2.0.2 → naeural_client-2.1.0}/naeural_client/base/instance.py

@@ -310,7 +310,7 @@ class Instance():
     def __register_transaction_for_instance_command(self, session_id: str = None, timeout: float = 0) -> list[Transaction]:
       """
       Register a new transaction for the instance command.
-      This method is called before sending an instance command to the Naeural edge node.
+      This method is called before sending an instance command to the Naeural Edge Protocol edge node.
 
       Parameters
       ----------
@@ -441,7 +441,7 @@ class Instance():
     def send_instance_command(self, command, payload=None, command_params=None, wait_confirmation=True, session_id=None, timeout=10):
       """
       Send a command to the instance.
-      This command can block until the command is confirmed by the Naeural edge node.
+      This command can block until the command is confirmed by the Naeural Edge Protocol edge node.
 
       Example:
       --------