naeural-client 2.0.1__py3-none-any.whl → 2.0.3__py3-none-any.whl

naeural_client/_ver.py

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

naeural_client/base/generic_session.py

@@ -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
@@ -1393,12 +1404,12 @@ 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
@@ -1552,7 +1563,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 +1597,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,7 +1651,9 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature,
+      signature="CUSTOM_CODE_FASTAPI_01",
+      endpoints=None,
+      use_ngrok=True,
       **kwargs
     ):
 
@@ -1652,8 +1665,16 @@ class GenericSession(BaseDecentrAIObject):
       instance = pipeline.create_plugin_instance(
         signature=signature,
         instance_id=self.log.get_unique_id(),
+        use_ngrok=use_ngrok,
         **kwargs
       )
+      
+      if endpoints is not None:
+        for endpoint in endpoints:
+          assert isinstance(endpoint, dict), "Each endpoint must be a dictionary defining the endpoint configuration."
+          instance.add_new_endpoint(**endpoint)
+        # end for
+      # end if we have endpoints defined in the call
 
       return pipeline, instance
 

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:
       --------

naeural_client/base/payload/payload.py

@@ -8,7 +8,7 @@ import numpy as np
 class Payload(UserDict):
   """
   This class enriches the default python dict, providing
-  helpful methods to process the payloads received from Naeural edge nodes.
+  helpful methods to process the payloads received from Naeural Edge Protocol edge nodes.
   """
 
   def get_images_as_np(self, key='IMG') -> list:
@@ -64,3 +64,16 @@ class Payload(UserDict):
     except ModuleNotFoundError:
       raise "This functionality requires the PIL library. To use this feature, please install it using 'pip install pillow'"
     return image
+
+
+if __name__ == "__main__":
+  import json
+  payload = Payload()
+  payload.data = {
+    "IMG": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAABKklEQVR42mNkAAwOyKg",
+    "TEST" : "TEST"
+  }
+  
+  print(type(payload), payload)
+  print(type(payload.data), payload.data)
+  print(json.dumps(payload.data, indent=2))

naeural_client/base/pipeline.py

@@ -54,7 +54,7 @@ class Pipeline(BaseCodeChecker):
         In the future, the documentation for the Logger base class will be available and developers will be able to use
         custom-made Loggers. 
     node_addr : str
-        Address of the Naeural edge node that will handle this pipeline.  
+        Address of the Naeural Edge Protocol edge node that will handle this pipeline.  
     name : str
         The name of this pipeline.
     data_source : str
@@ -91,7 +91,7 @@ class Pipeline(BaseCodeChecker):
     plugins = config.pop('PLUGINS', plugins)
 
     if is_attached:
-      assert existing_config is not None, "When attaching to a pipeline, the existing configuration should be found in the heartbeat of the Naeural edge node."
+      assert existing_config is not None, "When attaching to a pipeline, the existing configuration should be found in the heartbeat of the Naeural Edge Protocol edge node."
       assert config == {}, "Cannot provide a configuration when attaching to a pipeline."
       assert len(kwargs) == 0, "Cannot provide a configuration when attaching to a pipeline."
       self.config = {k.upper(): v for k, v in existing_config.items()}
@@ -201,7 +201,7 @@ class Pipeline(BaseCodeChecker):
     def __register_transactions_for_update(self, session_id: str = None, timeout: float = 0) -> list[Transaction]:
       """
       Register transactions for updating the pipeline and instances configuration. 
-      This method is called before sending an update pipeline configuration command to the Naeural edge node.
+      This method is called before sending an update pipeline configuration command to the Naeural Edge Protocol edge node.
 
       Parameters
       ----------
@@ -261,7 +261,7 @@ class Pipeline(BaseCodeChecker):
     def __register_transactions_for_delete(self, session_id: str = None, timeout: float = 0) -> list[Transaction]:
       """
       Register transactions for deleting the pipeline. 
-      This method is called before sending a delete pipeline command to the Naeural edge node.
+      This method is called before sending a delete pipeline command to the Naeural Edge Protocol edge node.
 
       Parameters
       ----------
@@ -294,7 +294,7 @@ class Pipeline(BaseCodeChecker):
     def __register_transaction_for_pipeline_command(self, session_id: str = None, timeout: float = 0) -> list[Transaction]:
       """
       Register a transaction for a pipeline command. 
-      This method is called before sending a pipeline command to the Naeural edge node.
+      This method is called before sending a pipeline command to the Naeural Edge Protocol edge node.
 
       Parameters
       ----------
@@ -366,7 +366,7 @@ class Pipeline(BaseCodeChecker):
 
     def __send_update_config_to_box(self, session_id=None):
       """
-      Send an update pipeline configuration command to the Naeural edge node.
+      Send an update pipeline configuration command to the Naeural Edge Protocol edge node.
       """
       self.session._send_command_update_pipeline_config(
           worker=self.node_addr,
@@ -668,7 +668,7 @@ class Pipeline(BaseCodeChecker):
   if True:
     def _on_data(self, signature, instance_id, data):
       """
-      Handle the data received from the Naeural edge node. This method is called by the Session object when a message is received from the Naeural edge node.
+      Handle the data received from the Naeural Edge Protocol edge node. This method is called by the Session object when a message is received from the Naeural Edge Protocol edge node.
       This method will call all the `on_data` callbacks of the pipeline and the instance that received the message.
 
       Parameters
@@ -690,7 +690,7 @@ class Pipeline(BaseCodeChecker):
 
     def _on_notification(self, signature, instance_id, data):
       """
-      Handle the notification received from the Naeural edge node. This method is called by the Session object when a notification is received from the Naeural edge node.
+      Handle the notification received from the Naeural Edge Protocol edge node. This method is called by the Session object when a notification is received from the Naeural Edge Protocol edge node.
 
       Parameters
       ----------
@@ -893,7 +893,7 @@ class Pipeline(BaseCodeChecker):
           The name of the instance. There can be multiple instances of the same plugin, mostly with different parameters
       custom_code : Callable[[CustomPluginTemplate], Any], optional
           A string containing the entire code, a path to a file containing the code as a string or a function with the code.
-          This code will be executed remotely on an Naeural edge node. Defaults to None.
+          This code will be executed remotely on an Naeural Edge Protocol edge node. Defaults to None.
       config : dict, optional
           parameters used to customize the functionality. One can change the AI engine used for object detection, 
           or finetune alerter parameters to better fit a camera located in a low light environment.
@@ -989,8 +989,8 @@ class Pipeline(BaseCodeChecker):
 
     def deploy(self, with_confirmation=True, wait_confirmation=True, timeout=10, verbose=False):
       """
-      This method is used to deploy the pipeline on the Naeural edge node. 
-      Here we collect all the proposed configurations and send them to the Naeural edge node.
+      This method is used to deploy the pipeline on the Naeural Edge Protocol edge node. 
+      Here we collect all the proposed configurations and send them to the Naeural Edge Protocol edge node.
       All proposed configs become staged configs.
       After all responses, apply the staged configs to finish the transaction. 
       """
@@ -1050,7 +1050,7 @@ class Pipeline(BaseCodeChecker):
       ----------
       custom_code : Callable[[CustomPluginTemplate], Any], optional
           A string containing the entire code, a path to a file containing the code as a string or a function with the code.
-          This code will be executed remotely on an Naeural edge node. Defaults to None.
+          This code will be executed remotely on an Naeural Edge Protocol edge node. Defaults to None.
       config : dict, optional
           parameters used to customize the functionality, by default {}
 
@@ -1281,8 +1281,8 @@ class Pipeline(BaseCodeChecker):
 
     def send_pipeline_command(self, command, payload=None, command_params=None, wait_confirmation=True, timeout=10) -> list[Transaction]:
       """
-      Send a pipeline command to the Naeural edge node.
-      This command can block until the command is confirmed by the Naeural edge node.
+      Send a pipeline command to the Naeural Edge Protocol edge node.
+      This command can block until the command is confirmed by the Naeural Edge Protocol edge node.
 
       Example:
       --------

naeural_client/base/plugin_template.py

@@ -1,3 +1,34 @@
+"""
+CustomPluginTemplate
+====================
+
+The `CustomPluginTemplate` class provides an interface to the on-edge `BasePluginExecutor`, facilitating the creation of custom plugins within the Neural Edge Protocol framework system. 
+It exposes all methods and properties defined on the target edge nodes, allowing developers to access any functionality needed for their custom plugins. 
+This interface supports code completion and documentation features, enhancing the development experience.
+
+Note that code using this class will be executed in a dedicated thread on the edge node during the plugin execution cycle.
+
+**Example Usage:**
+
+```python
+def some_custom_code(plugin: CustomPluginTemplate):
+    plugin.P("Hello World")  # Log a message on the edge node
+    obj = plugin.obj_cache.get('MyDict')
+    if obj is None:
+        obj = {
+            'counter': 0,
+            'some_data': 'some_value'
+        }
+        plugin.obj_cache['MyDict'] = obj
+
+    obj['counter'] += 1
+    plugin.P(f"Counter: {obj['counter']}")  # Log the counter value
+    # Finally, send a payload from the edge node to the client
+    return obj
+```
+"""
+
+
 class CustomPluginTemplate:
   @property
   def BytesIO(self):

naeural_client/base_decentra_object.py

@@ -32,7 +32,7 @@ class BaseDecentrAIObject(object):
       if not create_logger:
         raise ValueError("Logger object is invalid: {}".format(log))
       else:
-        log = Logger(DEBUG=DEBUG, base_folder='.', app_folder='_local_cache')
+        log = Logger("DEF", DEBUG=DEBUG, base_folder='.', app_folder='_local_cache')
     # endif
 
     self.log = log

naeural_client/code_cheker/base.py

@@ -9,7 +9,10 @@ import ctypes
 import threading
 import queue
 
-from .checker import ASTChecker, CheckerConstants
+try:
+  from .checker import ASTChecker, CheckerConstants
+except:
+  from naeural_client.code_cheker.checker import ASTChecker, CheckerConstants
 
 __VER__ = '0.6.1'
 
@@ -496,7 +499,7 @@ class BaseCodeChecker:
 
   def get_function_source_code(self, func):
     """
-    Get the source code of a function and remove the indentation.
+    Get the source code of a function including the docstring and remove the indentation.
 
     Parameters
     ----------
@@ -518,3 +521,27 @@ class BaseCodeChecker:
     plain_code = '\n'.join([line.rstrip()[indent:] for line in plain_code])
 
     return plain_code
+
+
+if __name__ == '__main__':
+  
+  def some_function(x):
+    """
+    A simple function that adds 1 to the input.
+
+    Parameters
+    ----------
+    x : _type_
+        _description_
+
+    Returns
+    -------
+    _type_
+        _description_
+    """
+    return x + 1
+  
+  checker = BaseCodeChecker()
+  source_code = checker.get_function_source_code(some_function)
+  print("some_function:\n" + source_code)
+  

naeural_client/const/environment.py

@@ -3,6 +3,7 @@ class ENVIRONMENT:
   AIXP_USER = 'AIXP_USER'
   EE_USERNAME = 'EE_USERNAME'
   EE_USER = 'EE_USER'
+  EE_MQTT_USER = 'EE_MQTT_USER'
 
   AIXP_PASSWORD = 'AIXP_PASSWORD'
   AIXP_PASS = 'AIXP_PASS'
@@ -10,14 +11,17 @@ class ENVIRONMENT:
   EE_PASSWORD = 'EE_PASSWORD'
   EE_PASS = 'EE_PASS'
   EE_PWD = 'EE_PWD'
+  EE_MQTT = 'EE_MQTT'
 
   AIXP_HOSTNAME = 'AIXP_HOSTNAME'
   AIXP_HOST = 'AIXP_HOST'
   EE_HOSTNAME = 'EE_HOSTNAME'
   EE_HOST = 'EE_HOST'
+  EE_MQTT_HOST = 'EE_MQTT_HOST'
 
   AIXP_PORT = 'AIXP_PORT'
   EE_PORT = 'EE_PORT'
+  EE_MQTT_PORT = 'EE_MQTT_PORT'
 
   AIXP_CERT_PATH = 'AIXP_CERT_PATH'
   EE_CERT_PATH = 'EE_CERT_PATH'

naeural_client/default/instance/custom_web_app_01_plugin.py

@@ -20,7 +20,54 @@ class CustomWebApp01(Instance):
 
     return name, args, base64_code
 
-  def add_new_endpoint(self, function, method="get"):
+
+  def get_proposed_assets(self):
+    from copy import deepcopy
+    proposed_config = self._get_proposed_config_dictionary(full=True)
+    if "ASSETS" in proposed_config:
+      return deepcopy(proposed_config["ASSETS"])
+    return deepcopy(self.config.get("ASSETS", {}))
+  
+
+  def get_proposed_jinja_args(self):
+    from copy import deepcopy
+    proposed_config = self._get_proposed_config_dictionary(full=True)
+    if "JINJA_ARGS" in proposed_config:
+      return deepcopy(proposed_config["JINJA_ARGS"])
+    return deepcopy(self.config.get("JINJA_ARGS", {}))
+
+
+  def add_new_endpoint(self, endpoint_type="default", **kwargs):
+    """
+    Add a new endpoint to a existing web app instance.
+
+    Parameters
+    ----------
+    endpoint_type : str, optional
+        The type of the endpoint. Can be "default", "file" or "html". The default is "default".
+
+    Raises
+    ------
+    ValueError
+        If the endpoint_type is invalid.
+    """
+    self.P("Attempting to add a new `{}` endpoint: {}".format(endpoint_type, kwargs))
+    if endpoint_type == "default":
+      self.add_new_function_endpoint(**kwargs)
+    elif endpoint_type == "file":
+      self.add_new_file_endpoint(**kwargs)
+    elif endpoint_type == "html":
+      self.add_new_html_endpoint(**kwargs)
+    else:
+      raise ValueError("Invalid endpoint type.")
+    return
+
+
+  def add_new_file_endpoint(self, str_code, file_name, endpoint_name):
+    raise NotImplementedError("This method is not implemented yet.")
+  
+  
+  def add_new_function_endpoint(self, function, method="get"):
     name, args, base64_code = self.get_endpoint_fields(function)
     dct_endpoint = {
       "NAME": name
@@ -40,23 +87,8 @@ class CustomWebApp01(Instance):
     dct_endpoint["ARGS"] = args
 
     self.update_instance_config(config={"ENDPOINTS": proposed_endpoints})
+    return  
 
-  def get_proposed_assets(self):
-    from copy import deepcopy
-    proposed_config = self._get_proposed_config_dictionary(full=True)
-    if "ASSETS" in proposed_config:
-      return deepcopy(proposed_config["ASSETS"])
-    return deepcopy(self.config.get("ASSETS", {}))
-
-  def get_proposed_jinja_args(self):
-    from copy import deepcopy
-    proposed_config = self._get_proposed_config_dictionary(full=True)
-    if "JINJA_ARGS" in proposed_config:
-      return deepcopy(proposed_config["JINJA_ARGS"])
-    return deepcopy(self.config.get("JINJA_ARGS", {}))
-
-  def add_new_file_endpoint(self, str_code, file_name, endpoint_name):
-    raise NotImplementedError("This method is not implemented yet.")
 
   def add_new_html_endpoint(self, html_path, web_app_file_name, endpoint_route):
     str_code = None
@@ -116,3 +148,4 @@ class CustomWebApp01(Instance):
     dict_name_route_method["route"] = endpoint_route
 
     self.update_instance_config(config={"ASSETS": proposed_assets, "JINJA_ARGS": proposed_jinja_args})
+    return

{naeural_client-2.0.1.dist-info → naeural_client-2.0.3.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.0.1
-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.0.3
+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
@@ -21,7 +21,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 +337,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 +348,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 +358,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.1.dist-info → naeural_client-2.0.3.dist-info}/RECORD

@@ -1,17 +1,17 @@
 naeural_client/__init__.py,sha256=ZNoadMrxrd1EZqxni0zpoqjFIBrS8Jg-vfZrr7xwe9I,498
-naeural_client/_ver.py,sha256=fIub_Shqx2sNADxzGW-jCCOKc15lrptdhn9y12jgzfM,330
-naeural_client/base_decentra_object.py,sha256=TBBnShUybWhjcbEIT8_27FGzxcQUVh23jm-HlaD9Qbw,4173
+naeural_client/_ver.py,sha256=22NfIkgjJksCD3HVuCZFvbFPyAMVCrB4W2uIX0hfSRw,330
+naeural_client/base_decentra_object.py,sha256=qDBpitcyhr1eEXPD8cGFtcNPNf71fqNRsmOEcCpx4sM,4180
 naeural_client/plugins_manager_mixin.py,sha256=X1JdGLDz0gN1rPnTN_5mJXR8JmqoBFQISJXmPR9yvCo,11106
 naeural_client/base/__init__.py,sha256=hACh83_cIv7-PwYMM3bQm2IBmNqiHw-3PAfDfAEKz9A,259
 naeural_client/base/distributed_custom_code_presets.py,sha256=cvz5R88P6Z5V61Ce1vHVVh8bOkgXd6gve_vdESDNAsg,2544
-naeural_client/base/generic_session.py,sha256=Dop4vI8mjB30OUFuMZ3gEDwvzDOXGqCrWsENtS-PRnI,65979
-naeural_client/base/instance.py,sha256=pZSYC_WQNa5YqU2cVN9vbDyCg8ums8EQCd5Cx95a_VQ,19942
-naeural_client/base/pipeline.py,sha256=21V9SN1v86iMm80jOikZIkooyBF9FMs_3_0Q9-Qp4sc,57288
-naeural_client/base/plugin_template.py,sha256=CzIMJIh36pDAtUIddlAPJ9OmHbmcFmph_F00rEKUp_0,136987
+naeural_client/base/generic_session.py,sha256=QEuXQVB3bCPk4CfrFVOwUHER1S6RzxH332GNgXvV3J4,67207
+naeural_client/base/instance.py,sha256=m6IKOWuT5GsZVSdFNdcR-ImJTpTdHqNoMe8KQlEK3Gc,19970
+naeural_client/base/pipeline.py,sha256=fWwSNUvvrVvJYzxRBCKTt1f9_pci1hCBiG2LtoyOpMU,57512
+naeural_client/base/plugin_template.py,sha256=qGaXByd_JZFpjvH9GXNbT7KaitRxIJB6-1IhbKrZjq4,138123
 naeural_client/base/responses.py,sha256=ZKBZmRhYDv8M8mQ5C_ahGsQvtWH4b9ImRcuerQdZmNw,6937
 naeural_client/base/transaction.py,sha256=bfs6td5M0fINgPQNxhrl_AUjb1YiilLDQ-Cd_o3OR_E,5146
 naeural_client/base/payload/__init__.py,sha256=y8fBI8tG2ObNfaXFWjyWZXwu878FRYj_I8GIbHT4GKE,29
-naeural_client/base/payload/payload.py,sha256=wejtDRg-hZZAzJD4Ud-AEW67gEbs1kNriimul95lyj4,1951
+naeural_client/base/payload/payload.py,sha256=v50D7mBBD2WwWzvpbRGMSr-X6vv5ie21IY1aDxTqe1c,2275
 naeural_client/bc/__init__.py,sha256=FQj23D1PrY06NUOARiKQi4cdj0-VxnoYgYDEht8lpr8,158
 naeural_client/bc/base.py,sha256=QK6QdONTpT9N--H7CHk8pwRxwJUGK4nvhNTfKxQeztQ,28328
 naeural_client/bc/chain.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,7 +19,7 @@ naeural_client/bc/ec.py,sha256=8ryEvc3__lVXSoYxd1WoTy9c8uC5Q_8R1uME7CeloIg,8578
 naeural_client/certs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 naeural_client/certs/r9092118.ala.eu-central-1.emqxsl.com.crt,sha256=y-6io0tseyx9-a4Pmde1z1gPULtJNSYUpG_YFkYaMKU,1337
 naeural_client/code_cheker/__init__.py,sha256=pwkdeZGVL16ZA4Qf2mRahEhoOvKhL7FyuQbMFLr1E5M,33
-naeural_client/code_cheker/base.py,sha256=cJzQD_Y-Z7lkiiQY65oJQAVABOmYez7TZB8xYSiuRl8,16669
+naeural_client/code_cheker/base.py,sha256=WIHP8LICypTBt7HR0FeC1KtIQ-PASTPaeFmCKvT5vuU,17190
 naeural_client/code_cheker/checker.py,sha256=QWupeM7ToancVIq1tRUxRNUrI8B5l5eoY0kDU4-O5aE,7365
 naeural_client/comm/__init__.py,sha256=za3B2HUKNXzYtjElMgGM9xbxNsdQfFY4JB_YzdyFkVU,76
 naeural_client/comm/amqp_wrapper.py,sha256=hzj6ih07DnLQy2VSfA88giDIFHaCp9uSdGLTA-IFE4s,8535
@@ -28,7 +28,7 @@ naeural_client/const/README.md,sha256=6OHesr-f5NBuuJGryEoi_TCu2XdlhfQYlDKx_IJoXe
 naeural_client/const/__init__.py,sha256=nm0maDn_l44UQkJy4XLHnOcpHMypkVvYYDFkezi6_rk,380
 naeural_client/const/base.py,sha256=V94oaT7xYrrTGxmLJlynxmbFujVX0G9wIfC8TilH5MU,2548
 naeural_client/const/comms.py,sha256=La6JXWHexH8CfcBCKyT4fCIoeaoZlcm7KtZ57ab4ZgU,2201
-naeural_client/const/environment.py,sha256=RygVb5l6oCYTt45Mupw0Gi44NbhpsnIpiiVu5TpCijg,580
+naeural_client/const/environment.py,sha256=Aj_AyelP_Y97CgEM6pvIv2T9TLbe7sT2mrkg6OtGShg,698
 naeural_client/const/formatter.py,sha256=AW3bWlqf39uaqV4BBUuW95qKYfF2OkkU4f9hy3kSVhM,200
 naeural_client/const/heartbeat.py,sha256=jGHmKfeHTFOXJaKUT3o_ocnQyF-EpcLeunW-ifkYKfU,2534
 naeural_client/const/misc.py,sha256=1ypROmZsOyp_8zG2LARwPeo-YfXuyYqZnml0elTP4kw,211
@@ -36,7 +36,7 @@ naeural_client/const/payload.py,sha256=k24vH9iJIBBPnCXx7HAEuli2fNAETK7h8ZuVKyKLg
 naeural_client/default/__init__.py,sha256=ozU6CMMuWl0LhG8Ae3LrZ65a6tLrptfscVYGf83zjxM,46
 naeural_client/default/instance/__init__.py,sha256=k1YZhbhLh7-Q7avnvwuQ2Ij-BhGbTlgwiWsOj9cS9xU,205
 naeural_client/default/instance/chain_dist_custom_job_01_plugin.py,sha256=-YO26dH3774wkMbj0Z0GACpVeVYblkxV4KhidtPEqcI,1891
-naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=gjckmyp0yoN24ouxelgc2Eb2p7YxrrAoSRQpshPZFDY,3991
+naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=9swEcfEzpL_P29WDkP9kTZ8oHNS0s9TXwd5BfIGiDZI,4805
 naeural_client/default/instance/net_mon_01_plugin.py,sha256=1k1Ul6pKyhSfAYbcfj38t404Z3KyMVvfhlMJdzIgV-c,1154
 naeural_client/default/instance/view_scene_01_plugin.py,sha256=bQtkQKrZRvzenlH3JYVvBXe2Tow5qdKYlmuvjpBLYn4,666
 naeural_client/default/session/mqtt_session.py,sha256=dpQcBhhVZDo458v0IqJMZb1CsTn-TxXhYjNlyJp9Rp8,2414
@@ -72,7 +72,7 @@ naeural_client/logging/tzlocal/windows_tz.py,sha256=Sv9okktjZJfRGGUOOppsvQuX_eXy
 naeural_client/utils/__init__.py,sha256=mAnke3-MeRzz3nhQvhuHqLnpaaCSmDxicd7Ck9uwpmI,77
 naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_LtMyCY,1072
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
-naeural_client-2.0.1.dist-info/METADATA,sha256=zmbnuRiXoI-A0Xhuy_Xqiyw9z9tjyJ3Qf5NY9B7oiHw,14339
-naeural_client-2.0.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-naeural_client-2.0.1.dist-info/licenses/LICENSE,sha256=7P07j9ez3_ovbZ8L_ZJuPXVOgqTS19-ECkezwOtFqOI,11340
-naeural_client-2.0.1.dist-info/RECORD,,
+naeural_client-2.0.3.dist-info/METADATA,sha256=5ONsD3fdCiVEh4Z3_h8bOkcbwz0RqBwCi0gP6YKzU5M,14479
+naeural_client-2.0.3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+naeural_client-2.0.3.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.0.3.dist-info/RECORD,,

{naeural_client-2.0.1.dist-info → naeural_client-2.0.3.dist-info}/licenses/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.