naeural-client 2.5.10__tar.gz → 2.5.11__tar.gz

{naeural_client-2.5.10 → naeural_client-2.5.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.5.10
+Version: 2.5.11
 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-2.5.10 → naeural_client-2.5.11}/naeural_client/_ver.py

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

{naeural_client-2.5.10 → naeural_client-2.5.11}/naeural_client/base/generic_session.py

@@ -1810,9 +1810,6 @@ class GenericSession(BaseDecentrAIObject):
       """
 
       ngrok_use_api = True
-      
-      # if isinstance(signature, str):
-        
 
       pipeline: WebappPipeline = self.create_pipeline(
         node=node,
@@ -1887,14 +1884,15 @@ class GenericSession(BaseDecentrAIObject):
       kwargs.pop('use_ngrok', None)
       kwargs.pop('ngrok_use_api', None)
       
-      # if isinstance(signature, str):
-      
+      if ngrok_edge_label is None:
+        raise ValueError("The `ngrok_edge_label` parameter is mandatory when creating a balanced web app, in order for all instances to respond to the same URL.")
+
       pipelines, instances = [], []
       
       for node in nodes:
         self.P("Creating web app on node {}...".format(node), color='b')
         pipeline: WebappPipeline = self.create_pipeline(
-          node=nodes[0],
+          node=node,
           name=name,
           pipeline_type=WebappPipeline,
           extra_debug=extra_debug,

{naeural_client-2.5.10 → naeural_client-2.5.11}/naeural_client/const/apps.py

@@ -6,6 +6,7 @@ class PLUGIN_SIGNATURES:
   NET_MON_01 = 'NET_MON_01'
   VIEW_SCENE_01 = 'VIEW_SCENE_01'
   CUSTOM_WEBAPI_01 = 'CUSTOM_CODE_FASTAPI_01'
+  GENERIC_WEB_APP = 'GENERIC_WEB_APP'
   CHAIN_DIST_CUSTOM_JOB_01 = 'PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST'
   TELEGRAM_BASIC_BOT_01 = 'TELEGRAM_BASIC_BOT_01'  
   TELEGRAM_CONVERSATIONAL_BOT_01 = 'TELEGRAM_CONVERSATIONAL_BOT_01'

{naeural_client-2.5.10 → naeural_client-2.5.11}/pyproject.toml

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

naeural_client-2.5.11/tutorials/ex13_launch_repo_based_webapp.py

@@ -0,0 +1,70 @@
+"""
+
+This demo starts a generic webapp and generates a dynamic URL that can be used to access the webapp.
+For this demo, we will use a custom webapp that resides at a public repository.
+
+"""
+from os import environ
+from naeural_client import Session, PLUGIN_SIGNATURES
+
+
+if __name__ == "__main__":
+  session = Session()
+
+  nodes = [
+    environ.get("TARGET_NODE_1", "INSERT_YOUR_NODE_ADDRESS_HERE"),
+    environ.get("TARGET_NODE_2", "INSERT_YOUR_NODE_ADDRESS_HERE")
+  ]
+
+  if isinstance(nodes, str):
+    nodes = [nodes]
+
+  for node in nodes:
+    session.wait_for_node(node)
+
+  # In case this is not provided and create_and_deploy_balanced_web_app is used an exception will be raised.
+  # In case this is not provided by the user, but create_webapp method is used, a unique URL will be generated by the ngrok service.
+  # Warning! create_webapp method does not support multiple nodes.
+  ngrok_edge_label = environ.get("NGROK_EDGE_LABEL", None)
+
+  # Defining the environment variables for the webapp.
+  port = 3000
+  env_vars = {
+    'APP_PORT': port,
+    'LOCAL_ADDRESS': '/edge_node/_local_cache/_data/local_address.txt'
+  }
+
+  # Defining the webapp setup commands.
+  setup_commands = [
+    "npm install"
+  ]
+
+  # Defining the assets of the application.
+  assets = {
+    'operation': "clone",
+    "url": "https://github.com/NaeuralEdgeProtocol/demo-deploy-nodejs",
+  }
+
+  # Defining the webapp run commands.
+  run_command = "npm start"
+
+  # instance: PLUGIN_TYPES.CUSTOM_WEBAPI_01
+  session.create_and_deploy_balanced_web_app(
+    nodes=nodes,
+    name="Ratio1_WebApp_tutorial",
+    signature=PLUGIN_SIGNATURES.GENERIC_WEB_APP,
+    env_vars=env_vars,
+    port=port,
+    setup_commands=setup_commands,
+    run_command=run_command,
+    ngrok_edge_label=ngrok_edge_label,
+    assets=assets
+  )
+
+  # 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.5.10/tutorials/ex13_launch_repo_based_webapp.py

@@ -1,26 +0,0 @@
-"""
-
-This demo starts a generic webapp and generates a dynamic URL that can be used to access the webapp.
-For this demo, we will use a custom webapp that resides at a public repository.
-
-"""
-
-from naeural_client import CustomPluginTemplate, Session, PLUGIN_TYPES
-
-
-if __name__ == "__main__":
-  session = Session()
-
-  node = "INSERT_YOUR_NODE_ADDRESS_HERE"
-  session.wait_for_node(node)
-
-  instance: PLUGIN_TYPES.CUSTOM_WEBAPI_01
-  pipeline, instance = session.create_web_app(
-  
-  )
-
-
-  url = pipeline.deploy()
-  
-  print(f"Webapp is now available at: {url}")
-