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

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

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

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

{naeural_client-2.5.9 → naeural_client-2.5.10}/naeural_client/bc/base.py

@@ -377,6 +377,7 @@ class BaseBlockEngine:
           password=self.__password,
         )
         self.P("  Loaded sk from {}".format(full_path), verbosity=1)
+        os.environ[BCct.K_USER_CONFIG_PEM_FILE] = self.__pem_file
       except:
         self.P("  Failed to load sk from {}".format(full_path), color='r', verbosity=1)
 

naeural_client-2.5.10/nepctl.MD

@@ -0,0 +1,159 @@
+# NepCTL Manual
+
+## Overview
+**NepCTL** (Naeural Edge Protocol Command-Line Tool) is a CLI utility for interacting with a decentralized network of nodes running Naeural Edge Protocol. It provides commands to query network nodes, configure the client, and manage nodes directly from the terminal.
+
+## Installation
+
+Installation is straightforward using `pip` so make sure you have python 3.9+ and pip installed on your system.
+
+```bash
+pip install naeural_client
+```
+
+Following the instalation make sure you edit `~/.naeural/config` file and put the correct mqtt broker credentials, particularly `EE_MQTT_USER` and `EE_MQTT` which are the username and password for the mqtt broker.
+
+```plaintext
+EE_MQTT_HOST=r9092118.ala.eu-central-1.emqxsl.com
+EE_MQTT_PORT=8883
+EE_MQTT_USER=
+EE_MQTT=
+
+EE_SECURED=true
+
+TARGET_NODE=
+```
+
+
+### General Usage
+```bash
+nepctl [COMMAND] [OPTIONS]
+```
+
+### Available Commands
+- **`get`**: Query nodes or supervisors.
+- **`config`**: Display and manage configuration settings.
+- **`restart`**: Restart a specific node.
+- **`shutdown`**: Shutdown a specific node.
+
+## Commands and Options
+
+### `get`
+Query nodes or supervisors in the network.
+
+#### `get nodes`
+Retrieve information about network nodes.
+
+**Options**:
+- `--all`: Get all known nodes.
+- `--online`: Get only online nodes.
+- `--supervisor="addr"`: Query nodes using a specific supervisor address.
+
+**Examples**:
+```bash
+# Get all known nodes:
+nepctl get nodes --all
+
+# Get online nodes using a specific supervisor:
+nepctl get nodes --online --supervisor="Amfnbt3N-qg2-qGtywZIPQBTVlAnoADVRmSAsdDhlQ-6"
+```
+
+#### `get supervisors`
+Retrieve information about supervisors in the network.
+
+**Examples**:
+```bash
+# Get all supervisors:
+nepctl get supervisors
+```
+
+### `config`
+Manage client configuration settings.
+
+#### `config show`
+Display the current configuration, including its location and client address.
+
+**Examples**:
+```bash
+# Show current configuration:
+nepctl config show
+```
+
+#### `config reset`
+Reset the configuration to its default values.
+
+**Examples**:
+```bash
+# Reset configuration:
+nepctl config reset
+```
+
+#### `config addr`
+Display the current client address.
+
+**Examples**:
+```bash
+# Show client address:
+nepctl config addr
+```
+
+### `restart`
+Restart a specific node.
+
+
+**Options**:
+- `node`: The address of the node to restart.
+
+**Examples**:
+```bash
+# Restart a node:
+nepctl restart --node="0xai_AleLPKqUHV-iPc-76-rUvDkRWW4dFMIGKW1xFVcy65nH"
+```
+
+### `shutdown`
+Shutdown a specific node.
+
+**Options**:
+- `node`: The address of the node to shutdown.
+
+**Examples**:
+```bash
+# Shutdown a node:
+nepctl shutdown --node="0xai_AhsgqiqJZzav1OHUlam7K9tZWysPv1QWcZU0AhFJ6wsJ"
+```
+
+## Example Outputs
+
+### `get nodes`
+```plaintext
+Network full map reported by <0xai_Amfnbt3N-qg2-qGtywZIPQBTVlAnoADVRmSAsdDhlQ-6>:
+                                              Address             Alias      Seen ago   Last state          Last probe   Zone  Supervisor
+0   0xai_AkSf-Ocgg2ykXwF-QvsA3VRDbV7pK02T2vpYZeelkgVb      40ffd6d6a742      08:10:56  LOST STATUS 2024-12-23 17:47:00  UTC+2       False
+...
+```
+
+### `get supervisors`
+```plaintext
+Supervisors reported by <0xai_AleLPKqUHV-iPc-76-rUvDkRWW4dFMIGKW1xFVcy65nH>:
+                                             Address      Alias  Seen ago Last state          Last probe   Zone  Supervisor
+0  0xai_Amfnbt3N-qg2-qGtywZIPQBTVlAnoADVRmSAsdDhlQ-6      nen-2  00:00:02     ONLINE 2024-12-24 02:06:03  UTC+2        True
+...
+```
+
+### `config show`
+```plaintext
+NEP SDK folder: /root/.naeural
+SDK Client address: 0xai_AjcIThkOqrPlp35-S8czHUOV-y4mnhksnLs8NGjTbmty
+Current configuration (/root/.naeural/config):
+
+EE_MQTT_HOST=r9092118.ala.eu-central-1.emqxsl.com
+EE_MQTT_PORT=8883
+EE_MQTT_USER=coreenaeural
+EE_MQTT=<password>
+...
+```
+
+## Notes
+- Use `--verbose` or `-v` for detailed output on any command. This can be rather useful for debugging purposes.
+- For help with any command or subcommand, append `-h` (e.g., `nepctl get nodes -h`).
+

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

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