Standardize configuration to yaml.

#2

Author: iTerminate

tools/developer_tools/bely-mqtt-message-broker/config.example.json

@@ -0,0 +1,25 @@
+# BELY MQTT Framework Configuration
+# This file configures global settings and handler-specific parameters
+
+# Global configuration shared across all handlers
+global:
+  # BELY API URL for querying additional information
+  bely_url: https://bely.gov/bely
+
+# Handler-specific configurations
+handlers:
+  # Advanced logging handler with custom directory
+  AdvancedLoggingHandler:
+    logging_dir: /var/log/bely
+
+  # Basic logging handler (no configuration needed)
+  LoggingHandler: {}
+
+  # Notification handler with webhook
+  NotificationHandler:
+    webhook_url: https://example.com/webhook
+
+  # Apprise smart notification handler
+  AppriseSmartNotificationHandler:
+    config:
+      config_path: /path/to/apprise_notification_config.yaml

tools/developer_tools/bely-mqtt-message-broker/config.example.yaml

@@ -10,16 +10,16 @@ bely-mqtt start [OPTIONS]
 
 ### MQTT Options
 
-- `--mqtt-host TEXT` - MQTT broker hostname (default: localhost)
-- `--mqtt-port INTEGER` - MQTT broker port (default: 1883)
-- `--mqtt-username TEXT` - MQTT username for authentication
-- `--mqtt-password TEXT` - MQTT password for authentication
-- `--mqtt-topic TEXT` - MQTT topic pattern to subscribe (default: bely/#)
+- `--broker-host TEXT` - MQTT broker hostname (default: localhost)
+- `--broker-port INTEGER` - MQTT broker port (default: 1883)
+- `--username TEXT` - MQTT username for authentication
+- `--password TEXT` - MQTT password for authentication
+- `--topic TEXT` - MQTT topic pattern to subscribe (default: bely/#)
 
 ### Handler Options
 
 - `--handlers-dir PATH` - Directory containing handler files (default: ./handlers)
-- `--handler-config PATH` - JSON configuration file for handlers
+- `--config PATH` - YAML configuration file for handlers
 
 ### API Options
 
@@ -29,33 +29,37 @@ bely-mqtt start [OPTIONS]
 ### Logging Options
 
 - `--log-level TEXT` - Logging level: DEBUG, INFO, WARNING, ERROR (default: INFO)
-- `--log-file PATH` - Log to file instead of console
 
 ## Environment Variables
 
 All command-line options can be set via environment variables:
 
 ```bash
-export MQTT_HOST=broker.example.com
-export MQTT_PORT=1883
+export MQTT_BROKER_HOST=broker.example.com
+export MQTT_BROKER_PORT=1883
+export MQTT_CLIENT_ID=bely-mqtt-client
 export MQTT_USERNAME=myuser
 export MQTT_PASSWORD=mypass
 export BELY_API_URL=https://api.bely.dev
 export BELY_API_KEY=your-api-key
+export BELY_HANDLERS_DIR=./handlers
+export BELY_CONFIG=./config.yaml
 export LOG_LEVEL=DEBUG
 ```
 
-## Configuration File
+## Configuration Files
 
-Create a `.env` file in your project root:
+### Environment File (.env)
+
+Create a `.env` file in your project root for environment variables:
 
 ```bash
 # MQTT Configuration
-MQTT_HOST=localhost
-MQTT_PORT=1883
+MQTT_BROKER_HOST=localhost
+MQTT_BROKER_PORT=1883
+MQTT_CLIENT_ID=bely-mqtt-client
 MQTT_USERNAME=
 MQTT_PASSWORD=
-MQTT_TOPIC=bely/#
 
 # BELY API Configuration
 BELY_API_URL=https://api.bely.dev
@@ -65,29 +69,43 @@ BELY_API_KEY=your-api-key-here
 LOG_LEVEL=INFO
 
 # Handler Configuration
-HANDLERS_DIR=./handlers
+BELY_HANDLERS_DIR=./handlers
+BELY_CONFIG=./config.yaml
 ```
 
-## Handler Configuration
-
-Handlers can be configured via JSON file:
-
-```json
-{
-  "handlers": [
-    {
-      "module": "notification_handler",
-      "class": "NotificationHandler",
-      "config": {
-        "webhook_url": "https://hooks.slack.com/services/YOUR/WEBHOOK",
-        "enabled": true
-      }
-    }
-  ]
-}
+### Handler Configuration (YAML)
+
+Handlers can be configured via a YAML file to provide both global and handler-specific settings:
+
+```yaml
+# Global configuration shared across all handlers
+global:
+  # BELY API URL for querying additional information
+  bely_url: https://bely.example.com/bely
+  # Add any other global parameters here
+  shared_param: value
+
+# Handler-specific configurations
+handlers:
+  # Configure the AdvancedLoggingHandler
+  AdvancedLoggingHandler:
+    logging_dir: /var/log/bely
+    log_level: DEBUG
+    rotate_logs: true
+    max_size_mb: 100
+  
+  # Configure the NotificationHandler
+  NotificationHandler:
+    webhook_url: https://hooks.slack.com/services/YOUR/WEBHOOK
+    enabled: true
+    timeout: 30
+  
+  # Configure the AppriseSmartNotificationHandler
+  AppriseSmartNotificationHandler:
+    config_path: /path/to/apprise_notification_config.yaml
 ```
 
-Use with: `--handler-config config.json`
+Use with: `--config config.yaml`
 
 ## SSL/TLS Configuration
 

tools/developer_tools/bely-mqtt-message-broker/docs/configuration.md

@@ -106,7 +106,7 @@ def cli() -> None:
     type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
     default=None,
     envvar="BELY_CONFIG",
-    help="Path to configuration file for handlers (JSON format).",
+    help="Path to configuration file for handlers (YAML format).",
 )
 def start(
     broker_host: str,

tools/developer_tools/bely-mqtt-message-broker/src/bely_mqtt/cli.py

@@ -5,11 +5,12 @@
 configuration parameters when they are instantiated.
 """
 
-import json
 import logging
 from pathlib import Path
 from typing import Any, Dict, Optional
 
+import yaml
+
 logger = logging.getLogger(__name__)
 
 
@@ -110,39 +111,37 @@ def __init__(self):
 
     def load_from_file(self, config_file: Path) -> None:
         """
-        Load configuration from a JSON file.
+        Load configuration from a YAML file.
 
         File format:
-            {
-              "global": {
-                "shared_param": "value",
-                "another_param": "value"
-              },
-              "handlers": {
-                "AdvancedLoggingHandler": {
-                  "logging_dir": "/var/log/bely"
-                },
-                "MyHandler": {
-                  "param1": "value1",
-                  "param2": "value2"
-                }
-              }
-            }
+            global:
+              shared_param: value
+              another_param: value
+              bely_url: https://bely.example.com
+
+            handlers:
+              AdvancedLoggingHandler:
+                logging_dir: /var/log/bely
+              MyHandler:
+                param1: value1
+                param2: value2
+              AppriseSmartNotificationHandler:
+                config_path: /path/to/apprise_config.yaml
 
         Args:
-            config_file: Path to the configuration file.
+            config_file: Path to the YAML configuration file.
 
         Raises:
             FileNotFoundError: If the configuration file doesn't exist.
-            json.JSONDecodeError: If the file is not valid JSON.
+            yaml.YAMLError: If the file is not valid YAML.
         """
         config_file = Path(config_file)
         if not config_file.exists():
             raise FileNotFoundError(f"Configuration file not found: {config_file}")
 
         try:
             with open(config_file) as f:
-                data = json.load(f)
+                data = yaml.safe_load(f)
 
             # Load global configuration if present
             if "global" in data:
@@ -155,8 +154,8 @@ def load_from_file(self, config_file: Path) -> None:
                 self.set_config(handler_name, config)
 
             self.logger.info(f"Loaded configuration from {config_file}")
-        except json.JSONDecodeError as e:
-            self.logger.error(f"Invalid JSON in configuration file: {e}")
+        except yaml.YAMLError as e:
+            self.logger.error(f"Invalid YAML in configuration file: {e}")
             raise
 
     def load_from_dict(self, config_dict: Dict[str, Any]) -> None: