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

naeural_client/__init__.py

@@ -11,3 +11,5 @@ from .base_decentra_object import BaseDecentrAIObject
 from .plugins_manager_mixin import _PluginsManagerMixin
 from .logging import Logger
 from .code_cheker import BaseCodeChecker
+from .const import PLUGIN_SIGNATURES
+from .default.instance import PLUGIN_TYPES

naeural_client/_ver.py

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

naeural_client/base/generic_session.py

@@ -9,7 +9,7 @@ from time import time as tm
 
 from ..base_decentra_object import BaseDecentrAIObject
 from ..bc import DefaultBlockEngine
-from ..const import COMMANDS, ENVIRONMENT, HB, PAYLOAD_DATA, STATUS_TYPE
+from ..const import COMMANDS, ENVIRONMENT, HB, PAYLOAD_DATA, STATUS_TYPE, PLUGIN_SIGNATURES
 from ..const import comms as comm_ct
 from ..io_formatter import IOFormatterWrapper
 from ..logging import Logger
@@ -1396,7 +1396,7 @@ class GenericSession(BaseDecentrAIObject):
     def create_or_attach_to_pipeline(self, *,
                                      node,
                                      name,
-                                     data_source,
+                                     data_source="Void",
                                      config={},
                                      plugins=[],
                                      on_data=None,
@@ -1410,15 +1410,21 @@ class GenericSession(BaseDecentrAIObject):
       ----------
       node : str
           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
           This is the name of the DCT plugin, which resembles the desired functionality of the acquisition.
+          Defaults to "Void" - no actual data acquisition.
+          
       config : dict, optional
           This is the dictionary that contains the configuration of the acquisition source, by default {}
+          
       plugins : list
           List of dictionaries which contain the configurations of each plugin instance that is desired to run on the box. 
           Defaults to []. Should be left [], and instances should be created with the api.
+          
       on_data : Callable[[Pipeline, str, str, dict], None], optional
           Callback that handles messages received from any plugin instance. 
           As arguments, it has a reference to this Pipeline object, the signature and the instance of the plugin
@@ -1426,15 +1432,18 @@ class GenericSession(BaseDecentrAIObject):
           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.
           Defaults to None.
+          
       on_notification : Callable[[Pipeline, dict], None], optional
           Callback that handles notifications received from any plugin instance. 
           As arguments, it has a reference to this Pipeline object, along with the payload itself. 
           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.
           Defaults to None.
+          
       max_wait_time : int, optional
           The maximum time to busy-wait, allowing the Session object to listen to node heartbeats
           and to check if the desired node is online in the network, by default 0.
+          
       **kwargs :
           The user can provide the configuration of the acquisition source directly as kwargs.
 
@@ -1651,15 +1660,39 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature="CUSTOM_CODE_FASTAPI_01",
+      signature=PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01,
       endpoints=None,
       use_ngrok=True,
       **kwargs
     ):
+      """
+      Create a new web app on a node.
+      
+      Parameters
+      ----------
+      
+      node : str
+          Address or Name of the Naeural Edge Protocol edge node that will handle this web app.
+          
+      name : str
+          Name of the web app.
+          
+      signature : str, optional
+          The signature of the plugin that will be used. Defaults to PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01.
+          
+      endpoints : list[dict], optional
+          A list of dictionaries defining the endpoint configuration. Defaults to None.
+          
+      use_ngrok : bool, optional
+          If True, will use ngrok to expose the web app. Defaults to True.
+          
+      
+      """
 
       pipeline: Pipeline = self.create_pipeline(
         node=node,
         name=name,
+        # default TYPE is "Void"
       )
 
       instance = pipeline.create_plugin_instance(
@@ -1677,6 +1710,43 @@ class GenericSession(BaseDecentrAIObject):
       # end if we have endpoints defined in the call
 
       return pipeline, instance
+    
+
+    def create_telegram_simple_bot(
+      self,
+      *,
+      node,
+      name,
+      signature=PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01,
+      message_handler=None,
+      telegram_bot_token=None,
+      telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY,
+      **kwargs
+    ):
+      
+      if telegram_bot_token is None:
+        telegram_bot_token = os.getenv(telegram_bot_token_env_key)
+        if telegram_bot_token is None:
+          message = f"Warning! No Telegram bot token provided as via env {ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY} or explicitly as `telegram_bot_token` param."
+          raise ValueError(message)
+      
+      b64code = self._get_base64_code(message_handler)
+
+      pipeline: Pipeline = self.create_pipeline(
+        node=node,
+        name=name,
+        # default TYPE is "Void"
+      )
+
+      instance = pipeline.create_plugin_instance(
+        signature=signature,
+        instance_id=self.log.get_unique_id(),
+        telegram_bot_token=telegram_bot_token,
+        message_handler=b64code,
+        **kwargs
+      )      
+      return pipeline, instance
+    
 
     def broadcast_instance_command_and_wait_for_response_payload(
       self,

naeural_client/const/__init__.py

@@ -7,3 +7,4 @@ from .payload import STATUS_TYPE, PAYLOAD_DATA, COMMANDS, NOTIFICATION_CODES
 from .base import CONFIG_STREAM, BIZ_PLUGIN_DATA, PLUGIN_INFO
 from . import heartbeat as HB
 from .environment import ENVIRONMENT
+from .apps import PLUGIN_SIGNATURES

naeural_client/const/apps.py

@@ -0,0 +1,11 @@
+class PLUGIN_SIGNATURES:
+  """
+  This class is used to store the plugin signatures for the different plugins.
+  It is complementary to the PLUGIN_TYPES class.
+  """
+  NET_MON_01 = 'NET_MON_01'
+  VIEW_SCENE_01 = 'VIEW_SCENE_01'
+  CUSTOM_WEB_APP_01 = 'CUSTOM_CODE_FASTAPI_01'
+  CHAIN_DIST_CUSTOM_JOB_01 = 'PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST'
+  BASIC_TELEGRAM_BOT_01 = 'BASIC_TELEGRAM_BOT_01'  
+  # INSERT_NEW_PLUGIN_HERE

naeural_client/const/environment.py

@@ -28,3 +28,5 @@ class ENVIRONMENT:
 
   EE_SECURED = 'EE_SECURED'
   AIXP_SECURED = 'AIXP_SECURED'
+  
+  TELEGRAM_BOT_TOKEN_ENV_KEY = 'TELEGRAM_BOT_TOKEN'

naeural_client/default/instance/__init__.py

@@ -2,3 +2,15 @@ from .net_mon_01_plugin import NetMon01
 from .view_scene_01_plugin import ViewScene01
 from .custom_web_app_01_plugin import CustomWebApp01
 from .chain_dist_custom_job_01_plugin import ChainDistCustomJob01
+from .basic_telegram_bot_01_plugin import BasicTelegramBot01
+
+
+class PLUGIN_TYPES:
+  """
+  The plugin types that are available in the default instance
+  """
+  NET_MON_01 = NetMon01
+  VIEW_SCENE_01 = ViewScene01
+  CUSTOM_WEB_APP_01 = CustomWebApp01
+  CHAIN_DIST_CUSTOM_JOB_01 = ChainDistCustomJob01
+  BASIC_TELEGRAM_BOT_01 = BasicTelegramBot01

naeural_client/default/instance/basic_telegram_bot_01_plugin.py

@@ -0,0 +1,5 @@
+from ...base import Instance
+from ...const import PLUGIN_SIGNATURES
+
+class BasicTelegramBot01(Instance):
+  signature = PLUGIN_SIGNATURES.BASIC_TELEGRAM_BOT_01

naeural_client/default/instance/chain_dist_custom_job_01_plugin.py

@@ -1,8 +1,9 @@
 from ...base import Instance
+from ...const import PLUGIN_SIGNATURES
 
 
 class ChainDistCustomJob01(Instance):
-  signature = "PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST"
+  signature = PLUGIN_SIGNATURES.CHAIN_DIST_CUSTOM_JOB_01
 
   def add_custom_code_callbacks(
       self,

naeural_client/default/instance/custom_web_app_01_plugin.py

@@ -1,8 +1,8 @@
 from ...base import Instance, Pipeline
-
+from ...const import PLUGIN_SIGNATURES
 
 class CustomWebApp01(Instance):
-  signature = "CUSTOM_CODE_FASTAPI_01"
+  signature = PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01
 
   def get_proposed_endpoints(self):
     from copy import deepcopy

naeural_client/default/instance/net_mon_01_plugin.py

@@ -1,8 +1,8 @@
 from ...base import Instance
-
+from ...const import PLUGIN_SIGNATURES
 
 class NetMon01(Instance):
-  signature = "NET_MON_01"
+  signature = PLUGIN_SIGNATURES.NET_MON_01
 
   def get_node_history(self, node_id=None, node_addr=None, time_window_hours=1, steps=20):
     """

naeural_client/default/instance/view_scene_01_plugin.py

@@ -1,8 +1,8 @@
 from ...base import Instance
-
+from ...const import PLUGIN_SIGNATURES
 
 class ViewScene01(Instance):
-  signature = "VIEW_SCENE_01"
+  signature = PLUGIN_SIGNATURES.VIEW_SCENE_01
 
   def get_last_witness(self, response_params_key="COMMAND_PARAMS"):
     """

naeural_client/logging/base_logger.py

@@ -180,11 +180,12 @@ class BaseLogger(object):
     if lib_ver == "":
       lib_ver = __VER__
     ver = "v{}".format(lib_ver) if lib_ver != "" else ""
-    self.verbose_log(
-      "SDK [{} {}] initialized on machine [{}][{}].".format(
-        self.__lib__, ver, self.MACHINE_NAME, self.get_processor_platform(),
+    self.P(
+      "NSDK {} initialized on [{}][{}].".format(
+        ver, self.MACHINE_NAME, self.get_processor_platform(),
       ),
-      color='green'
+      color='green',
+      boxed=True,
     )
     self.verbose_log("  Timezone: {}.".format(self.timezone),color='green')
 

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

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.0.3
+Version: 2.1.0
 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
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3

{naeural_client-2.0.3.dist-info → naeural_client-2.1.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-naeural_client/__init__.py,sha256=ZNoadMrxrd1EZqxni0zpoqjFIBrS8Jg-vfZrr7xwe9I,498
-naeural_client/_ver.py,sha256=22NfIkgjJksCD3HVuCZFvbFPyAMVCrB4W2uIX0hfSRw,330
+naeural_client/__init__.py,sha256=UKEDGS0wFYyxwmhEAKJGecO2vYbIfRYUP4SQgnK10IE,578
+naeural_client/_ver.py,sha256=PKIJgoKWB4wskSQA9KvdwJkGx2b-A3tKTo2Rq6DMhdw,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=QEuXQVB3bCPk4CfrFVOwUHER1S6RzxH332GNgXvV3J4,67207
+naeural_client/base/generic_session.py,sha256=azhJGCXstzBFQjWqW1z5OjwtSn2nkoPCNsSIcag5hIE,69231
 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
@@ -25,20 +25,22 @@ naeural_client/comm/__init__.py,sha256=za3B2HUKNXzYtjElMgGM9xbxNsdQfFY4JB_YzdyFk
 naeural_client/comm/amqp_wrapper.py,sha256=hzj6ih07DnLQy2VSfA88giDIFHaCp9uSdGLTA-IFE4s,8535
 naeural_client/comm/mqtt_wrapper.py,sha256=Ig3bFZkCbWd4y_Whn2PPa91Z3aLgNbNPau6Tn5yLPZ8,16167
 naeural_client/const/README.md,sha256=6OHesr-f5NBuuJGryEoi_TCu2XdlhfQYlDKx_IJoXeg,177
-naeural_client/const/__init__.py,sha256=nm0maDn_l44UQkJy4XLHnOcpHMypkVvYYDFkezi6_rk,380
+naeural_client/const/__init__.py,sha256=G7Fa50SpEhAPOnL8_mxgVmJ0Xq1qEncWd75pg2BkiG4,416
+naeural_client/const/apps.py,sha256=i0MNCM1Wf7QUCB4OKO1vGNUonPs6EsnZV6-XZjknppw,439
 naeural_client/const/base.py,sha256=V94oaT7xYrrTGxmLJlynxmbFujVX0G9wIfC8TilH5MU,2548
 naeural_client/const/comms.py,sha256=La6JXWHexH8CfcBCKyT4fCIoeaoZlcm7KtZ57ab4ZgU,2201
-naeural_client/const/environment.py,sha256=Aj_AyelP_Y97CgEM6pvIv2T9TLbe7sT2mrkg6OtGShg,698
+naeural_client/const/environment.py,sha256=bq21Q7e5FXpTNpoek_CUOX5oOZpSJEtNHXiZ79ZHe18,753
 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
 naeural_client/const/payload.py,sha256=k24vH9iJIBBPnCXx7HAEuli2fNAETK7h8ZuVKyKLgbk,5725
 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=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/instance/__init__.py,sha256=pHR9_5t3xv9ug3nu-8202yW-rqq-KR3C_L5N2xaADTA,548
+naeural_client/default/instance/basic_telegram_bot_01_plugin.py,sha256=STaIwtGCnEZdvxm7cF9NIQeZL5Zlru1c4cMSHKJc5pQ,159
+naeural_client/default/instance/chain_dist_custom_job_01_plugin.py,sha256=QtHi3uXKsVs9eyMgbnvBVbMylErhV1Du4X2-7zDL7Y0,1915
+naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=JblmfDa8ICppHItzEqU2HBSgT0nzZy9NWzgUHQ2sffw,4854
+naeural_client/default/instance/net_mon_01_plugin.py,sha256=u85i2AiYHkLJnam0wOx-m71hlp0EYyNtk3JwbkOrvHg,1208
+naeural_client/default/instance/view_scene_01_plugin.py,sha256=5kMhd23kL5AYCdOJzrdCqi2ohoQNvmpv8oE6hWQtUWk,720
 naeural_client/default/session/mqtt_session.py,sha256=dpQcBhhVZDo458v0IqJMZb1CsTn-TxXhYjNlyJp9Rp8,2414
 naeural_client/io_formatter/__init__.py,sha256=_wy7c-Z9kgb26jN7uNTDq88G7xZ3wI_ObuQd3QWNPkQ,85
 naeural_client/io_formatter/io_formatter_manager.py,sha256=MiZ70cGVD6hR99QiEk9wvJ_vADxpI-y2bTb0ITlMNI0,3451
@@ -49,7 +51,7 @@ naeural_client/io_formatter/default/a_dummy.py,sha256=qr9eUizQ-NN5jdXVzkaZKMaf9K
 naeural_client/io_formatter/default/aixp1.py,sha256=MX0TeUR4APA-qN3vUC6uzcz8Pssz5lgrQWo7td5Ri1A,3052
 naeural_client/io_formatter/default/default.py,sha256=gEy78cP2D5s0y8vQh4aHuxqz7D10gGfuiKF311QhrpE,494
 naeural_client/logging/__init__.py,sha256=b79X45VC6c37u32flKB2GAK9f-RR0ocwP0JDCy0t7QQ,33
-naeural_client/logging/base_logger.py,sha256=9FflGeC0m3zzcQB2QrRH0iebQn37FDe9r9BxNaoH1J0,65163
+naeural_client/logging/base_logger.py,sha256=tTxzCKOhcqGOtckHK8lQ1nUTNeaBNkeh0_SmDyzX6_Y,65146
 naeural_client/logging/small_logger.py,sha256=6wljiHP1moCkgohRnr2EX095eM2RtdJ5B3cytbO_Ow4,2887
 naeural_client/logging/logger_mixins/__init__.py,sha256=yQO7umlRvz63FeWpi-F9GRmC_MOHcNW6R6pwvZZBy3A,600
 naeural_client/logging/logger_mixins/class_instance_mixin.py,sha256=xUXE2VZgmrlrSrvw0f6GF1jlTnVLeVkIiG0bhlBfq3o,2741
@@ -72,7 +74,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.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.1.0.dist-info/METADATA,sha256=I71wSC0lZI0XDuh8j1mIcyHoxL8Y5SNcB0d_K31BTP0,14457
+naeural_client-2.1.0.dist-info/WHEEL,sha256=wukiCwsxxsuzcQTdnC_ZWHZECE4wwOh3xCCrap6i6Ts,87
+naeural_client-2.1.0.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.1.0.dist-info/RECORD,,

{naeural_client-2.0.3.dist-info → naeural_client-2.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.0
 Root-Is-Purelib: true
 Tag: py3-none-any