naeural-client 2.0.0__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.0 → 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.0 → naeural_client-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.0.0
+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
@@ -19,7 +19,7 @@ Requires-Dist: pyopenssl>=23.0.0
 Requires-Dist: python-dateutil
 Description-Content-Type: text/markdown
 
-# PyE2 SDK
+# naeural_client SDK
 
 This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Execution Engine processing nodes ecosystem. For further information please see [Naeural AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
 
@@ -30,7 +30,7 @@ This packet depends on the following packets: `pika`, `paho-mqtt`, `numpy`, `pyo
 ## Installation
 
 ```shell
-python -m pip install PyE2
+python -m pip install naeural_client
 ```
 
 ## Documentation
@@ -43,7 +43,7 @@ Code examples are located in the `tutorials` folder in the project's repository.
 ## Quick start guides
 
 Here you will find a selection of guides and documentation snippets to get
-you started with the `PyE2` SDK. These are only the most important aspects,
+you started with the `naeural_client` SDK. These are only the most important aspects,
 selected from the documentation and from the code examples. For more
 in-depth information, please consult the examples from the repository
 and the documentation.
@@ -160,7 +160,7 @@ These changes are the only ones a developer has to do to deploy his own custom c
 For this, we will create a new method, `remote_brute_force_prime_number_generator`, which will use the exposed edge node API methods.
 
 ```python
-from PyE2 import CustomPluginTemplate
+from naeural_client import CustomPluginTemplate
 
 # through the `plugin` object we get access to the edge node API
 # the CustomPluginTemplate class acts as a documentation for all the available methods and attributes
@@ -196,7 +196,7 @@ Now lets connect to the network and see what nodes are online.
 We will use the `on_heartbeat` callback to print the nodes.
 
 ```python
-from PyE2 import Session
+from naeural_client import Session
 from time import sleep
 
 def on_heartbeat(session: Session, node: str, heartbeat: dict):
@@ -244,7 +244,7 @@ Our selected node will periodically output partial results with the prime number
 Thus, we need to implement a callback method that will handle this.
 
 ```python
-from PyE2 import Pipeline
+from naeural_client import Pipeline
 
 # a flag used to close the session when the task is finished
 finished = False
@@ -267,7 +267,7 @@ def locally_process_partial_results(pipeline: Pipeline, full_payload):
 Now we are ready to deploy our job to the network.
 
 ```python
-from PyE2 import DistributedCustomCodePresets as Presets
+from naeural_client import DistributedCustomCodePresets as Presets
 
 _, _ = session.create_chain_dist_custom_job(
     # this is the main node, our entrypoint
@@ -335,11 +335,11 @@ For any inquiries related to the funding and its impact on this project, please
 # Citation
 
 ```bibtex
-@misc{PyE2,
+@misc{naeural_client,
   author = {Stefan Saraev, Andrei Damian},
-  title = {PyE2: Python SDK for Naeural Edge Protocol},
+  title = {naeural_client: Python SDK for Naeural Edge Protocol},
   year = {2024},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/PyE2}},
+  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/naeural_client}},
 }
 ```
 

{naeural_client-2.0.0 → naeural_client-2.0.2}/README.md

@@ -1,4 +1,4 @@
-# PyE2 SDK
+# naeural_client SDK
 
 This is the Python SDK package that allows interactions, development and deployment of jobs in Naeural network. The SDK enables low-code development and deployment of end-to-end AI (and not only) cooperative application pipelines within the Naeural Execution Engine processing nodes ecosystem. For further information please see [Naeural AI OS - Decentralized ubiquitous computing MLOps execution engine](https://arxiv.org/pdf/2306.08708).
 
@@ -9,7 +9,7 @@ This packet depends on the following packets: `pika`, `paho-mqtt`, `numpy`, `pyo
 ## Installation
 
 ```shell
-python -m pip install PyE2
+python -m pip install naeural_client
 ```
 
 ## Documentation
@@ -22,7 +22,7 @@ Code examples are located in the `tutorials` folder in the project's repository.
 ## Quick start guides
 
 Here you will find a selection of guides and documentation snippets to get
-you started with the `PyE2` SDK. These are only the most important aspects,
+you started with the `naeural_client` SDK. These are only the most important aspects,
 selected from the documentation and from the code examples. For more
 in-depth information, please consult the examples from the repository
 and the documentation.
@@ -139,7 +139,7 @@ These changes are the only ones a developer has to do to deploy his own custom c
 For this, we will create a new method, `remote_brute_force_prime_number_generator`, which will use the exposed edge node API methods.
 
 ```python
-from PyE2 import CustomPluginTemplate
+from naeural_client import CustomPluginTemplate
 
 # through the `plugin` object we get access to the edge node API
 # the CustomPluginTemplate class acts as a documentation for all the available methods and attributes
@@ -175,7 +175,7 @@ Now lets connect to the network and see what nodes are online.
 We will use the `on_heartbeat` callback to print the nodes.
 
 ```python
-from PyE2 import Session
+from naeural_client import Session
 from time import sleep
 
 def on_heartbeat(session: Session, node: str, heartbeat: dict):
@@ -223,7 +223,7 @@ Our selected node will periodically output partial results with the prime number
 Thus, we need to implement a callback method that will handle this.
 
 ```python
-from PyE2 import Pipeline
+from naeural_client import Pipeline
 
 # a flag used to close the session when the task is finished
 finished = False
@@ -246,7 +246,7 @@ def locally_process_partial_results(pipeline: Pipeline, full_payload):
 Now we are ready to deploy our job to the network.
 
 ```python
-from PyE2 import DistributedCustomCodePresets as Presets
+from naeural_client import DistributedCustomCodePresets as Presets
 
 _, _ = session.create_chain_dist_custom_job(
     # this is the main node, our entrypoint
@@ -314,11 +314,11 @@ For any inquiries related to the funding and its impact on this project, please
 # Citation
 
 ```bibtex
-@misc{PyE2,
+@misc{naeural_client,
   author = {Stefan Saraev, Andrei Damian},
-  title = {PyE2: Python SDK for Naeural Edge Protocol},
+  title = {naeural_client: Python SDK for Naeural Edge Protocol},
   year = {2024},
-  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/PyE2}},
+  howpublished = {\url{https://github.com/NaeuralEdgeProtocol/naeural_client}},
 }
 ```
 

naeural_client-2.0.2/__init__.py

@@ -0,0 +1,11 @@
+from .naeural_client import Payload, Pipeline, Session, Instance, CustomPluginTemplate
+from .naeural_client import base as naeural_client_base
+from .naeural_client import bc as naeural_client_bc
+from .naeural_client import comm as naeural_client_comm
+from .naeural_client import const as naeural_client_const
+from .naeural_client import io_formatter as naeural_client_io_formatter
+from .naeural_client import utils as naeural_client_utils
+from .naeural_client import load_dotenv
+from .naeural_client import __version__
+from .naeural_client import BaseDecentrAIObject, _PluginsManagerMixin, Logger
+from .naeural_client import BaseCodeChecker

{naeural_client-2.0.0 → naeural_client-2.0.2}/naeural_client/_ver.py

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

{naeural_client-2.0.0 → 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