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

naeural_client/_ver.py

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

naeural_client/base/generic_session.py

@@ -1640,7 +1640,9 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature,
+      signature="CUSTOM_CODE_FASTAPI_01",
+      endpoints=None,
+      use_ngrok=True,
       **kwargs
     ):
 
@@ -1652,8 +1654,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/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/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/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.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.0.1
+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

{naeural_client-2.0.1.dist-info → naeural_client-2.0.2.dist-info}/RECORD

@@ -1,13 +1,13 @@
 naeural_client/__init__.py,sha256=ZNoadMrxrd1EZqxni0zpoqjFIBrS8Jg-vfZrr7xwe9I,498
-naeural_client/_ver.py,sha256=fIub_Shqx2sNADxzGW-jCCOKc15lrptdhn9y12jgzfM,330
+naeural_client/_ver.py,sha256=l7yLqLlJKbOAi0-Y1OLeSMEafEsEAQAHaqoBwPAaV3U,330
 naeural_client/base_decentra_object.py,sha256=TBBnShUybWhjcbEIT8_27FGzxcQUVh23jm-HlaD9Qbw,4173
 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/generic_session.py,sha256=xlFonVvfgpuMqLHeRzIcVuqiZXxsJB4KvwAMY36yh64,66389
 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/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
@@ -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
@@ -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.2.dist-info/METADATA,sha256=y7AtPpCgmqhD-SMgBnndpNqkKOEV2LhM4Vxt6mM-5ts,14339
+naeural_client-2.0.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+naeural_client-2.0.2.dist-info/licenses/LICENSE,sha256=7P07j9ez3_ovbZ8L_ZJuPXVOgqTS19-ECkezwOtFqOI,11340
+naeural_client-2.0.2.dist-info/RECORD,,