mmrelay 1.0__tar.gz → 1.0.2__tar.gz

{mmrelay-1.0/src/mmrelay.egg-info → mmrelay-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.0
+Version: 1.0.2
 Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
 Home-page: https://github.com/geoffwhittington/meshtastic-matrix-relay
 Author: Geoff Whittington, Jeremiah K., and contributors
@@ -15,19 +15,32 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: meshtastic
-Requires-Dist: Pillow==11.1.0
+Requires-Dist: Pillow==11.2.1
 Requires-Dist: matrix-nio==0.25.2
 Requires-Dist: matplotlib==3.10.1
 Requires-Dist: requests==2.32.3
-Requires-Dist: markdown==3.7
+Requires-Dist: markdown==3.8
 Requires-Dist: haversine==2.9.0
 Requires-Dist: schedule==1.2.2
-Requires-Dist: platformdirs==4.2.0
+Requires-Dist: platformdirs==4.3.7
 Requires-Dist: py-staticmaps>=0.4.0
+Requires-Dist: rich==14.0.0
 Dynamic: license-file
 
 # M<>M Relay
 
+## ✨ Version 1.0 Released! ✨
+
+**We're excited to announce MMRelay v1.0 with improved packaging, standardized directories, and enhanced CLI!**
+
+**Existing users:** Version 1.0 requires a few quick migration steps:
+
+1. Follow the [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) guide for a smooth transition
+2. Move your configuration to the new standard location (`~/.mmrelay/config.yaml`)
+3. See [ANNOUNCEMENT.md](ANNOUNCEMENT.md) for all the exciting new features
+
+Not ready to upgrade yet? No problem! Run `git checkout 0.10.1` to continue using the previous version.
+
 ## (Meshtastic <=> Matrix Relay)
 
 A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
@@ -41,17 +54,19 @@ MMRelay runs on Linux, macOS, and Windows.
 ### Quick Installation
 
 ```bash
-# Install using pip
-pip install mmrelay
-
-# Or use pipx for isolated installation (recommended)
+# Install using pipx for isolated installation (recommended)
 pipx install mmrelay
+
+# Pip will also work if you prefer
+pip install mmrelay
 ```
 
+For pipx installation instructions, see: [pipx installation guide](https://pipx.pypa.io/stable/installation/#on-linux)
+
 ### Resources
 
 - **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
-- **Existing Users**: Check [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
+- **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
 - **Configuration**: Review [sample_config.yaml](sample_config.yaml) for examples
 
 ### Command-Line Options

{mmrelay-1.0 → mmrelay-1.0.2}/README.md

@@ -1,5 +1,17 @@
 # M<>M Relay
 
+## ✨ Version 1.0 Released! ✨
+
+**We're excited to announce MMRelay v1.0 with improved packaging, standardized directories, and enhanced CLI!**
+
+**Existing users:** Version 1.0 requires a few quick migration steps:
+
+1. Follow the [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) guide for a smooth transition
+2. Move your configuration to the new standard location (`~/.mmrelay/config.yaml`)
+3. See [ANNOUNCEMENT.md](ANNOUNCEMENT.md) for all the exciting new features
+
+Not ready to upgrade yet? No problem! Run `git checkout 0.10.1` to continue using the previous version.
+
 ## (Meshtastic <=> Matrix Relay)
 
 A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
@@ -13,17 +25,19 @@ MMRelay runs on Linux, macOS, and Windows.
 ### Quick Installation
 
 ```bash
-# Install using pip
-pip install mmrelay
-
-# Or use pipx for isolated installation (recommended)
+# Install using pipx for isolated installation (recommended)
 pipx install mmrelay
+
+# Pip will also work if you prefer
+pip install mmrelay
 ```
 
+For pipx installation instructions, see: [pipx installation guide](https://pipx.pypa.io/stable/installation/#on-linux)
+
 ### Resources
 
 - **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
-- **Existing Users**: Check [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
+- **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
 - **Configuration**: Review [sample_config.yaml](sample_config.yaml) for examples
 
 ### Command-Line Options

{mmrelay-1.0 → mmrelay-1.0.2}/requirements.txt

@@ -1,10 +1,11 @@
 meshtastic
-Pillow==11.1.0
+Pillow==11.2.1
 matrix-nio==0.25.2
 matplotlib==3.10.1
 requests==2.32.3
-markdown==3.7
+markdown==3.8
 haversine==2.9.0
 schedule==1.2.2
-platformdirs==4.2.0
+platformdirs==4.3.7
 py-staticmaps>=0.4.0
+rich==14.0.0

{mmrelay-1.0 → mmrelay-1.0.2}/sample_config.yaml

@@ -22,10 +22,11 @@ meshtastic:
 
 logging:
   level: info
-  #log_to_file: true                          # Default is false
-  #filename: ~/.mmrelay/logs/mmrelay.log      # Default location
+  #log_to_file: true                          # Set to true to enable file logging
+  #filename: ~/.mmrelay/logs/mmrelay.log      # Default location if log_to_file is true
   #max_log_size: 10485760                     # 10 MB default if omitted
   #backup_count: 1                            # Keeps 1 backup as the default if omitted
+  #color_enabled: true                        # Set to false to disable colored console output
 
 #database:
 #  path: ~/.mmrelay/data/meshtastic.sqlite   # Default location

{mmrelay-1.0 → mmrelay-1.0.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mmrelay
-version = 1.0
+version = 1.0.2
 author = Geoff Whittington, Jeremiah K., and contributors
 author_email = jeremiahk@gmx.com
 description = Bridge between Meshtastic mesh networks and Matrix chat rooms
@@ -23,15 +23,16 @@ packages = find:
 python_requires = >=3.8
 install_requires = 
 	meshtastic
-	Pillow==11.1.0
+	Pillow==11.2.1
 	matrix-nio==0.25.2
 	matplotlib==3.10.1
 	requests==2.32.3
-	markdown==3.7
+	markdown==3.8
 	haversine==2.9.0
 	schedule==1.2.2
-	platformdirs==4.2.0
+	platformdirs==4.3.7
 	py-staticmaps>=0.4.0
+	rich==14.0.0
 
 [options.packages.find]
 where = src

mmrelay-1.0.2/src/mmrelay/__init__.py

@@ -0,0 +1,17 @@
+"""
+Meshtastic Matrix Relay - Bridge between Meshtastic mesh networks and Matrix chat rooms.
+"""
+
+import os
+import pkg_resources
+
+# First try to get version from environment variable (GitHub tag)
+if "GITHUB_REF_NAME" in os.environ:
+    __version__ = os.environ.get("GITHUB_REF_NAME")
+else:
+    # Fall back to setup.cfg metadata using pkg_resources (compatible with PyInstaller)
+    try:
+        __version__ = pkg_resources.get_distribution("mmrelay").version
+    except pkg_resources.DistributionNotFound:
+        # If all else fails, use hardcoded version
+        __version__ = "1.0.1"

{mmrelay-1.0 → mmrelay-1.0.2}/src/mmrelay/cli.py

@@ -94,6 +94,13 @@ def get_version():
     return __version__
 
 
+def print_version():
+    """
+    Print the version in a simple format.
+    """
+    print(f"MMRelay v{__version__}")
+
+
 def check_config(args=None):
     """
     Check if the configuration file is valid.
@@ -262,7 +269,7 @@ def main():
 
     # Handle --version
     if args.version:
-        print(f"mmrelay {get_version()}")
+        print_version()
         return 0
 
     # If no command was specified, run the main functionality
@@ -289,7 +296,7 @@ def handle_cli_commands(args):
     """
     # Handle --version
     if args.version:
-        print(f"mmrelay {get_version()}")
+        print_version()
         return True
 
     # Handle --install-service

{mmrelay-1.0 → mmrelay-1.0.2}/src/mmrelay/config.py

@@ -187,7 +187,7 @@ def load_config(config_file=None, args=None):
 
     # If a specific config file was provided, use it
     if config_file and os.path.isfile(config_file):
-        logger.info(f"Loading configuration from: {config_file}")
+        # Store the config path but don't log it yet - will be logged by main.py
         with open(config_file, "r") as f:
             relay_config = yaml.load(f, Loader=SafeLoader)
         config_path = config_file
@@ -200,10 +200,9 @@ def load_config(config_file=None, args=None):
     for path in config_paths:
         if os.path.isfile(path):
             config_path = path
-            logger.info(f"Loading configuration from: {config_path}")
+            # Store the config path but don't log it yet - will be logged by main.py
             with open(config_path, "r") as f:
                 relay_config = yaml.load(f, Loader=SafeLoader)
-            logger.info(f"Loaded configuration with keys: {list(relay_config.keys())}")
             return relay_config
 
     # No config file found

{mmrelay-1.0 → mmrelay-1.0.2}/src/mmrelay/log_utils.py

@@ -2,44 +2,84 @@ import logging
 import os
 from logging.handlers import RotatingFileHandler
 
+from rich.console import Console
+from rich.logging import RichHandler
+
 from mmrelay.cli import parse_arguments
 from mmrelay.config import get_log_dir
 
+# Initialize Rich console
+console = Console()
+
+# Define custom log level styles - not used directly but kept for reference
+# Rich 14.0.0+ supports level_styles parameter, but we're using an approach
+# that works with older versions too
+LOG_LEVEL_STYLES = {
+    "DEBUG": "dim blue",
+    "INFO": "green",
+    "WARNING": "yellow",
+    "ERROR": "bold red",
+    "CRITICAL": "bold white on red",
+}
+
 # Global config variable that will be set from main.py
 config = None
 
+# Global variable to store the log file path
+log_file_path = None
+
 
 def get_logger(name):
     logger = logging.getLogger(name=name)
 
     # Default to INFO level if config is not available
     log_level = logging.INFO
+    color_enabled = True  # Default to using colors
 
-    # Try to get log level from config
+    # Try to get log level and color settings from config
     global config
-    if config is not None and "logging" in config and "level" in config["logging"]:
-        log_level = getattr(logging, config["logging"]["level"].upper())
+    if config is not None and "logging" in config:
+        if "level" in config["logging"]:
+            log_level = getattr(logging, config["logging"]["level"].upper())
+        # Check if colors should be disabled
+        if "color_enabled" in config["logging"]:
+            color_enabled = config["logging"]["color_enabled"]
 
     logger.setLevel(log_level)
     logger.propagate = False
 
-    # Add stream handler (console logging)
-    stream_handler = logging.StreamHandler()
-    stream_handler.setFormatter(
-        logging.Formatter(
-            fmt="%(asctime)s %(levelname)s:%(name)s:%(message)s",
-            datefmt="%Y-%m-%d %H:%M:%S %z",
+    # Add handler for console logging (with or without colors)
+    if color_enabled:
+        # Use Rich handler with colors
+        console_handler = RichHandler(
+            rich_tracebacks=True,
+            console=console,
+            show_time=True,
+            show_level=True,
+            show_path=False,
+            markup=True,
+            log_time_format="%Y-%m-%d %H:%M:%S",
+            omit_repeated_times=False,
+        )
+        console_handler.setFormatter(logging.Formatter("%(name)s: %(message)s"))
+    else:
+        # Use standard handler without colors
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(
+            logging.Formatter(
+                fmt="%(asctime)s %(levelname)s:%(name)s:%(message)s",
+                datefmt="%Y-%m-%d %H:%M:%S %z",
+            )
         )
-    )
-    logger.addHandler(stream_handler)
+    logger.addHandler(console_handler)
 
     # Check command line arguments for log file path
     args = parse_arguments()
 
-    # Check if file logging is enabled
+    # Check if file logging is enabled (default to True for better user experience)
     if (
         config is not None
-        and config.get("logging", {}).get("log_to_file", False)
+        and config.get("logging", {}).get("log_to_file", True)
         or args.logfile
     ):
         # Priority: 1. Command line arg, 2. Config file, 3. Default location (~/.mmrelay/logs)
@@ -64,21 +104,10 @@ def get_logger(name):
         if log_dir:  # Ensure non-empty directory paths exist
             os.makedirs(log_dir, exist_ok=True)
 
-        # Log which file we're using (only for the first logger)
+        # Store the log file path for later use
         if name == "M<>M Relay":
-            # Create a basic logger to log the log file path
-            # This is needed because we can't use the logger we're creating to log its own creation
-            basic_logger = logging.getLogger("LogSetup")
-            basic_logger.setLevel(logging.INFO)
-            basic_handler = logging.StreamHandler()
-            basic_handler.setFormatter(
-                logging.Formatter(
-                    fmt="%(asctime)s %(levelname)s:%(name)s:%(message)s",
-                    datefmt="%Y-%m-%d %H:%M:%S %z",
-                )
-            )
-            basic_logger.addHandler(basic_handler)
-            basic_logger.info(f"Writing logs to: {log_file}")
+            global log_file_path
+            log_file_path = log_file
 
         # Create a file handler for logging
         try:

{mmrelay-1.0 → mmrelay-1.0.2}/src/mmrelay/main.py

@@ -10,8 +10,9 @@ import sys
 
 from nio import ReactionEvent, RoomMessageEmote, RoomMessageNotice, RoomMessageText
 
+# Import version from package
 # Import meshtastic_utils as a module to set event_loop
-from mmrelay import meshtastic_utils
+from mmrelay import __version__, meshtastic_utils
 from mmrelay.db_utils import (
     initialize_database,
     update_longnames,
@@ -33,6 +34,18 @@ logger = get_logger(name="M<>M Relay")
 logging.getLogger("nio").setLevel(logging.ERROR)
 
 
+# Flag to track if banner has been printed
+_banner_printed = False
+
+def print_banner():
+    """Print a simple startup message with version information."""
+    global _banner_printed
+    # Only print the banner once
+    if not _banner_printed:
+        logger.info(f"Starting MMRelay v{__version__}")
+        _banner_printed = True
+
+
 async def main(config):
     """
     Main asynchronous function to set up and run the relay.
@@ -202,6 +215,9 @@ def run_main(args):
     Returns:
         int: Exit code (0 for success, non-zero for failure)
     """
+    # Print the banner at startup
+    print_banner()
+
     # Handle the --data-dir option
     if args and args.data_dir:
         import os
@@ -245,6 +261,19 @@ def run_main(args):
     set_config(db_utils, config)
     set_config(base_plugin, config)
 
+    # Get config path and log file path for logging
+    from mmrelay.config import config_path
+    from mmrelay.log_utils import log_file_path
+
+    # Create a logger with a different name to avoid conflicts with the one in config.py
+    config_rich_logger = get_logger("ConfigInfo")
+
+    # Now log the config file and log file locations with the properly formatted logger
+    if config_path:
+        config_rich_logger.info(f"Config file location: {config_path}")
+    if log_file_path:
+        config_rich_logger.info(f"Log file location: {log_file_path}")
+
     # Check if config exists and has the required keys
     required_keys = ["matrix", "meshtastic", "matrix_rooms"]
 

{mmrelay-1.0 → mmrelay-1.0.2}/src/mmrelay/meshtastic_utils.py

@@ -1,6 +1,8 @@
 import asyncio
 import contextlib
 import io
+import os
+import sys
 import threading
 import time
 from typing import List
@@ -46,6 +48,32 @@ shutting_down = False
 reconnect_task = None  # To keep track of the reconnect task
 
 
+def is_running_as_service():
+    """
+    Check if the application is running as a systemd service.
+    This is used to determine whether to show Rich progress indicators.
+
+    Returns:
+        bool: True if running as a service, False otherwise
+    """
+    # Check for INVOCATION_ID environment variable (set by systemd)
+    if os.environ.get("INVOCATION_ID"):
+        return True
+
+    # Check if parent process is systemd
+    try:
+        with open("/proc/self/status") as f:
+            for line in f:
+                if line.startswith("PPid:"):
+                    ppid = int(line.split()[1])
+                    with open(f"/proc/{ppid}/comm") as p:
+                        return p.read().strip() == "systemd"
+    except (FileNotFoundError, PermissionError, ValueError):
+        pass
+
+    return False
+
+
 def serial_port_exists(port_name):
     """
     Check if the specified serial port exists.
@@ -118,7 +146,7 @@ def connect_meshtastic(passed_config=None, force_connect=False):
                 if connection_type == "serial":
                     # Serial connection
                     serial_port = config["meshtastic"]["serial_port"]
-                    logger.info(f"Connecting to serial port {serial_port} ...")
+                    logger.info(f"Connecting to serial port {serial_port}")
 
                     # Check if serial port exists before connecting
                     if not serial_port_exists(serial_port):
@@ -137,7 +165,9 @@ def connect_meshtastic(passed_config=None, force_connect=False):
                     # BLE connection
                     ble_address = config["meshtastic"].get("ble_address")
                     if ble_address:
-                        logger.info(f"Connecting to BLE address {ble_address} ...")
+                        logger.info(f"Connecting to BLE address {ble_address}")
+
+                        # Connect without progress indicator
                         meshtastic_client = meshtastic.ble_interface.BLEInterface(
                             address=ble_address,
                             noProto=False,
@@ -151,7 +181,9 @@ def connect_meshtastic(passed_config=None, force_connect=False):
                 elif connection_type == "tcp":
                     # TCP connection
                     target_host = config["meshtastic"]["host"]
-                    logger.info(f"Connecting to host {target_host} ...")
+                    logger.info(f"Connecting to host {target_host}")
+
+                    # Connect without progress indicator
                     meshtastic_client = meshtastic.tcp_interface.TCPInterface(
                         hostname=target_host
                     )
@@ -244,7 +276,25 @@ async def reconnect():
                 logger.info(
                     f"Reconnection attempt starting in {backoff_time} seconds..."
                 )
-                await asyncio.sleep(backoff_time)
+
+                # Show reconnection countdown with Rich (if not in a service)
+                if not is_running_as_service():
+                    from rich.progress import Progress, TextColumn, BarColumn, TimeRemainingColumn
+                    with Progress(
+                        TextColumn("[cyan]Meshtastic: Reconnecting in"),
+                        BarColumn(),
+                        TextColumn("[cyan]{task.percentage:.0f}%"),
+                        TimeRemainingColumn(),
+                        transient=True,
+                    ) as progress:
+                        task = progress.add_task("Waiting", total=backoff_time)
+                        for _ in range(backoff_time):
+                            if shutting_down:
+                                break
+                            await asyncio.sleep(1)
+                            progress.update(task, advance=1)
+                else:
+                    await asyncio.sleep(backoff_time)
                 if shutting_down:
                     logger.debug(
                         "Shutdown in progress. Aborting reconnection attempts."