naeural-client 3.0.5__tar.gz → 3.0.7__tar.gz

{naeural_client-3.0.5 → naeural_client-3.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 3.0.5
+Version: 3.0.7
 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/NaeuralEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues

{naeural_client-3.0.5 → naeural_client-3.0.7}/naeural_client/_ver.py

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

{naeural_client-3.0.5 → naeural_client-3.0.7}/naeural_client/base/generic_session.py

@@ -89,7 +89,7 @@ class GenericSession(BaseDecentrAIObject):
               on_notification=None,
               on_heartbeat=None,
               debug_silent=True,
-              debug=False,
+              debug=1,
               silent=False,
               verbosity=1,
               dotenv_path=None,
@@ -145,6 +145,7 @@ class GenericSession(BaseDecentrAIObject):
         As arguments, it has a reference to this Session object, the node name, the pipeline, signature and instance, and the payload.
         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.
+        
     on_notification : Callable[[Session, str, dict], None], optional
         Callback that handles notifications received from this network.
         As arguments, it has a reference to this Session object, the node name and the notification payload.
@@ -153,6 +154,7 @@ class GenericSession(BaseDecentrAIObject):
         This callback will be called when there are notifications related to the node itself, e.g. when the node runs
         low on memory.
         Defaults to None.
+        
     on_heartbeat : Callable[[Session, str, dict], None], optional
         Callback that handles heartbeats received from this network.
         As arguments, it has a reference to this Session object, the node name and the heartbeat payload.
@@ -162,8 +164,12 @@ class GenericSession(BaseDecentrAIObject):
         This flag will disable debug logs, set to 'False` for a more verbose log, by default True
         Observation: Obsolete, will be removed
         
-    debug : bool, optional
-        This flag will enable debug logs, set to 'False` for a more verbose log, by default False
+    debug : bool or int, optional
+        This flag will enable debug logs, set to 'True` or 2 for a more verbose log, by default 1
+        - 0 or False will disable debug logs
+        - 1 will enable level 1
+        - 2 will enable full debug
+        
         
         
     silent : bool, optional
@@ -185,8 +191,11 @@ class GenericSession(BaseDecentrAIObject):
         If True, the SDK will use the home folder as the base folder for the local cache.
         NOTE: if you need to use development style ./_local_cache, set this to False.
     """
-    
     debug = debug or not debug_silent
+    if isinstance(debug, bool):
+      debug = 2 if debug else 0
+    
+    self.__debug = int(debug) > 0
     
     self.__at_least_one_node_peered = False
     self.__at_least_a_netmon_received = False
@@ -278,13 +287,20 @@ class GenericSession(BaseDecentrAIObject):
       
     super(GenericSession, self).__init__(
       log=log, 
-      DEBUG=debug, 
+      DEBUG=int(debug) > 1, 
       create_logger=True,
       silent=self.silent,
       local_cache_base_folder=local_cache_base_folder,
       local_cache_app_folder=local_cache_app_folder,
     )
     return
+  
+  def Pd(self, *args, **kwargs):
+    if self.__debug:
+      kwargs["color"] = 'd' if kwargs.get("color") != 'r' else 'r'
+      self.log.P(*args, **kwargs)
+    return
+  
 
   def startup(self):    
     ## 1st config step - we prepare config via ~/.naeural/config or .env
@@ -830,7 +846,7 @@ class GenericSession(BaseDecentrAIObject):
             if needs_netconfig:
               lst_netconfig_request.append(node_addr)
           # end for each node in network map
-          self.P(f"Net mon from <{sender_addr}> `{ee_id}`:  {len(online_addresses)}/{len(all_addresses)}", color='y')
+          self.Pd(f"Net mon from <{sender_addr}> `{ee_id}`:  {len(online_addresses)}/{len(all_addresses)}")
           if len(lst_netconfig_request) > 0:
             self.__request_pipelines_from_net_config_monitor(lst_netconfig_request)
           # end if needs netconfig
@@ -1607,7 +1623,7 @@ class GenericSession(BaseDecentrAIObject):
       )
       self.bc_engine.sign(msg_to_send, use_digest=True)
       if show_command:
-        self.P(
+        self.Pd(
           "Sending command '{}' to '{}':\n{}".format(command, worker, json.dumps(msg_to_send, indent=2)),
           color='y',
           verbosity=1
@@ -1778,6 +1794,7 @@ class GenericSession(BaseDecentrAIObject):
                         on_notification=None,
                         max_wait_time=0,
                         pipeline_type=None,
+                        debug=False,
                         **kwargs) -> Pipeline:
       """
       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.
@@ -1857,6 +1874,7 @@ class GenericSession(BaseDecentrAIObject):
           on_data=on_data,
           on_notification=on_notification,
           is_attached=False,
+          debug=debug,
           **kwargs
       )
       self.own_pipelines.append(pipeline)

{naeural_client-3.0.5 → naeural_client-3.0.7}/naeural_client/base/instance.py

@@ -9,7 +9,19 @@ class Instance():
   The Instance class is a wrapper around a plugin instance. It provides a simple API for sending commands to the instance and updating its configuration.
   """
 
-  def __init__(self, log, pipeline, instance_id, signature, on_data=None, on_notification=None, config={}, is_attached=False, **kwargs):
+  def __init__(
+    self, 
+    log, 
+    pipeline, 
+    instance_id, 
+    signature, 
+    on_data=None, 
+    on_notification=None, 
+    config={}, 
+    is_attached=False, 
+    debug=False,
+    **kwargs
+  ):
     """
     Create a new instance of the plugin.
 
@@ -39,6 +51,7 @@ class Instance():
     self.instance_id = instance_id
     self.signature = signature.upper()
     self.config = {}
+    self.__debug = debug
 
     if is_attached:
       assert len(kwargs) == 0, "When attaching an instance, no additional parameters are allowed"
@@ -61,6 +74,12 @@ class Instance():
       self.on_notification_callbacks.append(on_notification)
 
     return
+  
+  def Pd(self, *args, **kwargs):
+    if self.__debug:
+      kwargs["color"] = 'd' if kwargs.get("color") != 'r' else 'r'
+      self.log.P(*args, **kwargs)
+    return
 
   # Message handling
   if True:
@@ -75,6 +94,7 @@ class Instance():
       data : dict | Payload
           The data received from the instance
       """
+      self.Pd(f"_on_data: {pipeline.name}:{self.signature}:{self.instance_id}")
       for callback in self.on_data_callbacks:
         callback(pipeline, data)
       for callback in self.temporary_on_data_callbacks.values():
@@ -503,7 +523,7 @@ class Instance():
           The list of transactions generated, or None if `wait_confirmation` is False.
 
       """
-      self.P(f'Sending command <{command}> to instance <{self.__repr__()}>', color="b")
+      self.Pd(f'Sending command <{command}> to instance <{self.__repr__()}>', color="b")
 
       self.__was_last_operation_successful = None
 

{naeural_client-3.0.5 → naeural_client-3.0.7}/naeural_client/base/pipeline.py

@@ -40,6 +40,7 @@ class Pipeline(BaseCodeChecker):
     on_notification=None, 
     is_attached=False, 
     existing_config=None, 
+    debug=False,
     **kwargs
   ) -> None:
     """
@@ -99,6 +100,7 @@ class Pipeline(BaseCodeChecker):
     self.session = session
     self.node_addr = node_addr
     self.name = name
+    self.__debug = debug
 
     self.config = {}
     plugins = config.pop('PLUGINS', plugins)
@@ -148,10 +150,28 @@ class Pipeline(BaseCodeChecker):
 
     self.__init_plugins(plugins, is_attached)
     return
+  
+  def Pd(self, *args, **kwargs):
+    """
+    Print debug message.
+    """
+    if self.__debug:
+      kwargs["color"] = 'd' if kwargs.get("color") != 'r' else 'r'
+      self.P(*args, **kwargs)
+    return
 
   # Utils
   if True:
-    def __init_instance(self, signature, instance_id, config, on_data, on_notification, is_attached):
+    def __init_instance(
+      self, 
+      signature, 
+      instance_id, 
+      config, 
+      on_data, 
+      on_notification, 
+      is_attached,
+      debug=False,
+    ):
       instance_class = None
       str_signature = None
       if isinstance(signature, str):
@@ -160,15 +180,17 @@ class Pipeline(BaseCodeChecker):
       else:
         instance_class = signature
         str_signature = instance_class.signature.upper()
-      instance = instance_class(self.log,
-                                pipeline=self,
-                                signature=str_signature,
-                                instance_id=instance_id,
-                                config=config,
-                                on_data=on_data,
-                                on_notification=on_notification,
-                                is_attached=is_attached
-                                )
+      instance = instance_class(
+        self.log,
+        pipeline=self,
+        signature=str_signature,
+        instance_id=instance_id,
+        config=config,
+        on_data=on_data,
+        on_notification=on_notification,
+        is_attached=is_attached,
+        debug=debug, 
+      )
       self.lst_plugin_instances.append(instance)
       return instance
 
@@ -710,6 +732,7 @@ class Pipeline(BaseCodeChecker):
           The payload of the message.
       """
       # call all self callbacks
+      self.Pd(f"Pipeline <{self.name}> received data from <{signature}:{instance_id}>")
       for callback in self.on_data_callbacks:
         callback(self, signature, instance_id, data)
 
@@ -834,6 +857,7 @@ class Pipeline(BaseCodeChecker):
       config={}, 
       on_data=None, 
       on_notification=None, 
+      debug=False,
       **kwargs
     ) -> Instance:
       """
@@ -884,7 +908,11 @@ class Pipeline(BaseCodeChecker):
 
       # create the new instance and add it to the list
       config = {**config, **kwargs}
-      instance = self.__init_instance(signature, instance_id, config, on_data, on_notification, is_attached=False)
+      instance = self.__init_instance(
+        signature=signature, instance_id=instance_id, config=config, 
+        on_data=on_data, on_notification=on_notification, is_attached=False,
+        debug=debug
+      )
       return instance
 
     def __remove_plugin_instance(self, instance):

{naeural_client-3.0.5 → naeural_client-3.0.7}/naeural_client/ipfs/r1fs.py

@@ -268,8 +268,8 @@ class R1FSEngine:
   
   def _get_unique_or_complete_upload_name(self, fn=None, prefix="r1fs", suffix=""):
     if fn is not None and os.path.dirname(fn) == "":
-      return os.path.join(self.__uploads_dir, fn)
-    return self._get_unique_upload_name(prefix, suffix)
+      return os.path.join(self.__uploads_dir, f"{fn}{suffix}")
+    return self._get_unique_upload_name(prefix, suffix=suffix)
   
   def __set_reprovider_interval(self):
     # Command to set the Reprovider.Interval to 1 minute
@@ -566,6 +566,7 @@ class R1FSEngine:
     msg += f"\n  Download: {self.__downloads_dir}"
     msg += f"\n  Upload:   {self.__uploads_dir}"
     msg += f"\n  SwarmKey: {hidden_base64_swarm_key}"
+    msg += f"\n  Debug:    {self.__debug}"
     self.P(msg, color='d')
     
     ipfs_repo = os.path.expanduser("~/.ipfs")

{naeural_client-3.0.5 → naeural_client-3.0.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "3.0.5"
+version = "3.0.7"
 authors = [
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },
   { name="Cristan Bleotiu", email="cristibleotiu@gmail.com" },

naeural_client-3.0.7/tutorials/ex02_part3_deploy_r1fs_test.py

@@ -0,0 +1,59 @@
+import json
+from naeural_client import Instance, Payload, Pipeline, Session, PAYLOAD_DATA
+
+def instance_on_data(pipeline: Pipeline, payload: Payload):
+  # we extract the payload and do a minimal processing
+  # this is the payload key sent by the demo plugin
+  R1FS_DEMO_DATA_KEY = "R1FS_DATA" 
+  # next convert to the data object for convenience
+  data = payload.data 
+  # then we extract the sender alias directly from the payload
+  sender_alias = data[PAYLOAD_DATA.EE_ID] 
+  # we extract the r1fs data if it is present
+  r1fs_data = data.get(R1FS_DEMO_DATA_KEY) 
+  if r1fs_data is None:
+    # we ignore the payload if the data is not present
+    return 
+  # then we extract the R1FS file originator (creator) from the demo data
+  read_file_originator = r1fs_data["owner_id"] 
+  # we print the data 
+  pipeline.P("Data received from worker '{}' from file created by '{}':\n {}".format(
+    sender_alias, read_file_originator, json.dumps(r1fs_data, indent=2)
+  ))
+  return
+
+if __name__ == '__main__':
+
+  session: Session = Session()
+  
+  # this code assumes the node have "allowed" the SDK to deploy the pipeline
+  nodes = [
+    '0xai_A2LfyeItL5oEp7nHONlczGgwS3SV8Ims9ujJ0soJ6Anx',
+    '0xai_AqgKnJMNvUvq5n1wIin_GD2i1FbZ4FBTUJaCI6cWf7i4',
+  ]
+
+  for node in nodes:
+    session.P(f"Deploying pipeline to node: {node}")
+    session.wait_for_node(node) # we wait for the node to be ready
+    pipeline: Pipeline = session.create_pipeline(
+      node=node, name='r1fs_demo_pipeline', data_source='Void',
+      debug=True,
+    )
+    # The ideea is that we create a plugin instance that listens for data
+    # on ChainStorage from other plugins/nodes that create R1FS demo files
+    # while itself also creating R1FS demo files
+    instance: Instance = pipeline.create_plugin_instance(
+      signature='R1FS_DEMO', on_data=instance_on_data,
+      instance_id='inst01',
+      debug=True,
+    )
+
+    pipeline.deploy()
+  WAIT_TIME = 150
+  session.P(f"All pipelines deployed, we wait for {WAIT_TIME} seconds...")
+  session.wait(
+    seconds=WAIT_TIME,            # we wait the session for 60 seconds
+    close_pipelines=True,   # we close the pipelines after the session
+    close_session=True,     # we close the session after the session
+  )
+  session.P("Main thread exiting...")

{naeural_client-3.0.5 → naeural_client-3.0.7}/xperimental/_checks/web3_check.py

@@ -1,4 +1,4 @@
-
+import os
 import json
 
 
@@ -9,6 +9,9 @@ from naeural_client.utils.config import get_user_folder
 
 
 if __name__ == '__main__' :
+  
+  os.environ["EE_EVM_NET"] = "devnet"
+  
   l = Logger(
     "ENC", base_folder=str(get_user_folder()), 
     app_folder="_local_cache"
@@ -20,7 +23,7 @@ if __name__ == '__main__' :
       }
   )
   
-  network = None
+  
   addresses = [
     "0xE486F0d594e9F26931fC10c29E6409AEBb7b5144",
     "0x93B04EF1152D81A0847C2272860a8a5C70280E14",    
@@ -30,7 +33,7 @@ if __name__ == '__main__' :
   
   for addr in addresses:
     is_active = eng.web3_is_node_licensed(
-      address=addr, network=network, debug=True
+      address=addr, debug=True
     )
     l.P("{} {}".format(
         addr,
@@ -39,7 +42,7 @@ if __name__ == '__main__' :
       color='g' if is_active else 'r'
     )
     
-  oracles = eng.web3_get_oracles(network=network, debug=True)
+  oracles = eng.web3_get_oracles(debug=True)
   l.P("\nOracles:\n {}".format(json.dumps(oracles, indent=2)), 
     color='b'
   )
@@ -47,6 +50,7 @@ if __name__ == '__main__' :
   supervisors = [
     "0xai_AleLPKqUHV-iPc-76-rUvDkRWW4dFMIGKW1xFVcy65nH",
     "0xai_A-Bn9grkqH1GUMTZUqHNzpX5DA6PqducH9_JKAlBx6YL",
+    "0xai_AmT2Tz230aZtNFh3ruOr7rN3KHuAcByOEPmZ-Qa8Km4A"
   ]
   
   for supervisor in supervisors: