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

naeural_client-2.0.2/.devcontainer/Dockerfile

@@ -0,0 +1,26 @@
+# Simple ultr-lightweight image for python development
+# Use the latest Python 3 slim image for a lightweight base
+FROM python:3.11-slim
+
+# Set the working directory
+WORKDIR /workspace
+
+# Install system dependencies required for some Python packages
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    libffi-dev \
+    libssl-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install the SDK requirements
+RUN pip install --no-cache-dir \
+    pika \
+    paho-mqtt \
+    numpy \
+    "pyopenssl>=23.0.0" \
+    "cryptography>=39.0.0" \
+    python-dateutil \
+    pyaml
+
+# Set the default command to bash (optional)
+CMD ["bash"]

naeural_client-2.0.2/.devcontainer/devcontainer.json

@@ -0,0 +1,21 @@
+{
+  "name" : "Naeural SDK Development Container",
+  "dockerFile" : "Dockerfile",
+  // "image": "aidamian/image:tag",
+
+  "runArgs": [
+    //"--gpus=all",
+    "--hostname",
+    "sdk_dev"    
+  ],
+
+
+  "customizations": {
+    "vscode" : {
+      "extensions": [
+        "ms-python.python",
+        "ms-toolsai.jupyter"
+      ]
+    }
+  }
+}

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

@@ -143,8 +143,7 @@ inference/model_testing/_solisbox/_logs/MPTF.txt
 inference/model_testing/_solisbox/_logs/20211224_102325_MPTF_001_log.txt
 
 
-# vscode stuff
-.vscode
+
 plugins/libs/_cache/
 core/utils/_cache/
 plugins/business/scoring_plugins/_solisbox/

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

@@ -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 → naeural_client-2.0.2}/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-2.0.1 → naeural_client-2.0.2}/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-2.0.1 → naeural_client-2.0.2}/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-2.0.1 → naeural_client-2.0.2}/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-2.0.1 → naeural_client-2.0.2}/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 → naeural_client-2.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "2.0.1"
+version = "2.0.2"
 authors = [
   { name="Stefan Saraev", email="saraevstefan@gmail.com" },
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/1. connect_to_network.py

@@ -20,6 +20,12 @@ if __name__ == '__main__':
       on_heartbeat=on_heartbeat
   )
 
-  # run the program for 10 seconds, then close the session
-  session.run(wait=10, close_session=True)
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=60, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )
   session.P("Main thread exiting...")

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/2. first_deploy.py

@@ -55,6 +55,11 @@ if __name__ == '__main__':
 
   pipeline.deploy()
 
-  # run the program for 30 seconds, then close the session
-  session.run(wait=30, close_session=True, close_pipelines=True)
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=60, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )
   session.P("Main thread exiting...")

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/3. custom_code_on_one_remote__example_1.py

@@ -71,4 +71,12 @@ if __name__ == "__main__":
 
   p.deploy()
 
-  s.run(wait=60, close_pipelines=True)
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  s.run(
+    wait=60, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )
+

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/4. custom_code_on_one_remote__example_2.py

@@ -94,4 +94,11 @@ if __name__ == "__main__":
 
   pipeline.deploy()
 
-  session.run(wait=60, close_pipelines=True)
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=60, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/5. custom_code_on_one_remote__example_3.py

@@ -129,4 +129,11 @@ if __name__ == "__main__":
 
   p.deploy()
 
-  s.run(wait=60, close_pipelines=True)
+ 
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  s.run(
+    wait=60, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/6. custom_code_on_multiple_remotes__example_1.py

@@ -95,6 +95,10 @@ if __name__ == "__main__":
     deploy=True
   )
 
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
   # process incoming messages until the finish condition is met
   s.run(wait=lambda: len(final_result) == 0, close_pipelines=True, close_session=True)
 

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/7. custom_code_on_multiple_remotes__example_2.py

@@ -173,6 +173,11 @@ if __name__ == "__main__":
 
   p.deploy()
 
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+
   # process incoming messages until the finish condition is met
   s.run(wait=lambda: len(final_result) == 0, close_pipelines=True, close_session=True)
 

naeural_client-2.0.2/tutorials/8. custom_web_app.py

@@ -0,0 +1,111 @@
+from naeural_client import CustomPluginTemplate, Session
+from naeural_client.default.instance import CustomWebApp01
+
+# this tutorial can be run only on the local edge node
+# because it uses ngrok to expose the fastapi server
+# and this requires an ngrok auth token
+
+# See https://naeural-013.ngrok.app/docs
+
+
+def hello_world(plugin, name: str = "naeural_developer"):
+  # name is a query parameter
+  return f"Hello, {name}! I am {plugin.e2_addr}"
+
+
+def get_uuid(plugin: CustomPluginTemplate):
+  return f"New uuid: {plugin.uuid()}!"
+
+
+def get_addr(plugin: CustomPluginTemplate):
+  return plugin.node_addr
+
+
+def predict(plugin: CustomPluginTemplate, series: list[int], steps: int) -> list:
+  """
+  This function is used to predict the next `steps` values of the time series `series`.
+
+  Parameters
+  ----------
+  series : list[int]
+      A list of integers representing the time series.
+  steps : int
+      The number of steps to predict.
+
+  Returns
+  -------
+  list
+      A list of integers representing the predicted values.
+  """
+  result = plugin.basic_ts_fit_predict(series, steps)
+  result = list(map(int, result))
+  return result
+
+
+if __name__ == "__main__":
+  session = Session()
+
+  node = "INSERT_YOUR_NODE_ADDRESS_HERE"
+  session.wait_for_node(node)
+
+  instance: CustomWebApp01
+  pipeline, instance = session.create_web_app(
+    node=node,
+    name="naeural_predict_app",    
+    ngrok_edge_label="INSERT_YOUR_NGROK_EDGE_LABEL_HERE",
+    endpoints=[
+      {
+        # we omit the "endpoint_type" key, because the default value is "default" ie the "function" type
+        "function": hello_world,
+        "method": "get",
+      },
+      {
+        "function": get_uuid,
+        "method": "get",
+      },
+      {
+        "function": get_addr,
+        "method": "get",
+      },
+      {
+        "function": predict,
+        "method": "post",
+      },
+      {
+        "endpoint_type": "html",
+        "html_path": "tutorials/8. custom_code_fastapi_assets/index.html",
+        "web_app_file_name": "index.html",
+        "endpoint_route": "/",
+      }
+    ]
+  )
+
+  # we could have added the endpoints one by one
+  # # GET request on <domain>/hello_world?name=naeural_developer
+  # instance.add_new_endpoint(hello_world)
+
+  # # GET request on <domain>/get_uuid
+  # instance.add_new_endpoint(get_uuid, method="get")
+
+  # # GET request on <domain>/get_addr
+  # instance.add_new_endpoint(get_addr, method="get")
+
+  # # POST request on <domain>/forecasting (with body as json with 2 keys: series and steps)
+  # instance.add_new_endpoint(predict, method="post")
+
+  # # add an html file to the web app, accessible at <domain>/
+  # instance.add_new_html_endpoint(
+  #   html_path="tutorials/8. custom_code_fastapi_assets/index.html",
+  #   web_app_file_name="index.html",
+  #   endpoint_route="/",
+  # )
+
+  pipeline.deploy()
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=True, # wait for the user to stop the execution
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )

{naeural_client-2.0.1 → naeural_client-2.0.2}/tutorials/9. code_sandbox_from_scratch.py

@@ -44,4 +44,11 @@ if __name__ == "__main__":
 
   pipeline.deploy()
 
-  session.run(close_pipelines=True)
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=True, # wait for the user to stop the execution or a given time
+    close_pipelines=True # when the user stops the execution, the remote edge-node pipelines will be closed
+  )

naeural_client-2.0.1/tutorials/8. custom_web_app.py

@@ -1,67 +0,0 @@
-from naeural_client import CustomPluginTemplate, Session
-from naeural_client.default.instance import CustomWebApp01
-
-# this tutorial can be run only on the local edge node
-# because it uses ngrok to expose the fastapi server
-# and this requires an ngrok auth token
-
-# See https://naeural-013.ngrok.app/docs
-
-
-def hello_world(plugin, name: str = "naeural_developer"):
-  # name is a query parameter
-  return f"Hello, {name}! I am {plugin.e2_addr}"
-
-
-def get_uuid(plugin: CustomPluginTemplate):
-  return f"New uuid: {plugin.uuid()}!"
-
-
-def get_addr(plugin: CustomPluginTemplate):
-  return plugin.node_addr
-
-
-def predict(plugin: CustomPluginTemplate, series: list[int], steps: int) -> list:
-  result = plugin.basic_ts_fit_predict(series, steps)
-  result = list(map(int, result))
-  return result
-
-
-if __name__ == "__main__":
-  session = Session()
-
-  node = "INSERT_YOUR_NODE_ADDRESS_HERE"
-  session.wait_for_node(node)
-
-  instance: CustomWebApp01
-  pipeline, instance = session.create_web_app(
-    node=node,
-    name="naeural_predict_app",
-    signature=CustomWebApp01,
-
-    ngrok_edge_label="INSERT_YOUR_NGROK_EDGE_LABEL_HERE",
-    use_ngrok=True,
-  )
-
-  # GET request on <domain>/hello_world?name=naeural_developer
-  instance.add_new_endpoint(hello_world)
-
-  # GET request on <domain>/get_uuid
-  instance.add_new_endpoint(get_uuid, method="get")
-
-  # GET request on <domain>/get_addr
-  instance.add_new_endpoint(get_addr, method="get")
-
-  # POST request on <domain>/forecasting (with body as json with 2 keys: series and steps)
-  instance.add_new_endpoint(predict, method="post")
-
-  # add an html file to the web app, accessible at <domain>/
-  instance.add_new_html_endpoint(
-    html_path="tutorials/8. custom_code_fastapi_assets/index.html",
-    web_app_file_name="index.html",
-    endpoint_route="/",
-  )
-
-  pipeline.deploy()
-
-  session.run(close_pipelines=True)