mmrelay 1.0.6__py3-none-any.whl → 1.0.7__py3-none-any.whl

mmrelay/cli.py

@@ -3,6 +3,7 @@ Command-line interface handling for the Meshtastic Matrix Relay.
 """
 
 import argparse
+import importlib.resources
 import os
 import sys
 
@@ -11,6 +12,7 @@ from yaml.loader import SafeLoader
 
 # Import version from package
 from mmrelay import __version__
+from mmrelay.tools import get_sample_config_path
 
 
 def parse_arguments():
@@ -363,29 +365,65 @@ def generate_sample_config():
     # Ensure the directory exists
     os.makedirs(os.path.dirname(target_path), exist_ok=True)
 
-    # Try to find the sample config file
-    # First, check in the package directory
-    package_dir = os.path.dirname(__file__)
-    sample_config_path = os.path.join(
-        os.path.dirname(os.path.dirname(package_dir)), "sample_config.yaml"
-    )
+    # Use the helper function to get the sample config path
+    sample_config_path = get_sample_config_path()
 
-    # If not found, try the repository root
-    if not os.path.exists(sample_config_path):
-        repo_root = os.path.dirname(os.path.dirname(__file__))
-        sample_config_path = os.path.join(repo_root, "sample_config.yaml")
+    if os.path.exists(sample_config_path):
+        # Copy the sample config file to the target path
+        import shutil
 
-    # If still not found, try the current directory
-    if not os.path.exists(sample_config_path):
-        sample_config_path = os.path.join(os.getcwd(), "sample_config.yaml")
+        shutil.copy2(sample_config_path, target_path)
+        print(f"Generated sample config file at: {target_path}")
+        print(
+            "\nEdit this file with your Matrix and Meshtastic settings before running mmrelay."
+        )
+        return True
+
+    # If the helper function failed, try using importlib.resources directly
+    try:
+        # Try to get the sample config from the package resources
+        sample_config_content = (
+            importlib.resources.files("mmrelay.tools")
+            .joinpath("sample_config.yaml")
+            .read_text()
+        )
+
+        # Write the sample config to the target path
+        with open(target_path, "w") as f:
+            f.write(sample_config_content)
 
-    if os.path.exists(sample_config_path):
-        shutil.copy(sample_config_path, target_path)
         print(f"Generated sample config file at: {target_path}")
         print(
             "\nEdit this file with your Matrix and Meshtastic settings before running mmrelay."
         )
         return True
-    else:
+    except (FileNotFoundError, ImportError, OSError) as e:
+        print(f"Error accessing sample_config.yaml: {e}")
+
+        # Fallback to traditional file paths if importlib.resources fails
+        # First, check in the package directory
+        package_dir = os.path.dirname(__file__)
+        sample_config_paths = [
+            # Check in the tools subdirectory of the package
+            os.path.join(package_dir, "tools", "sample_config.yaml"),
+            # Check in the package directory
+            os.path.join(package_dir, "sample_config.yaml"),
+            # Check in the repository root
+            os.path.join(
+                os.path.dirname(os.path.dirname(package_dir)), "sample_config.yaml"
+            ),
+            # Check in the current directory
+            os.path.join(os.getcwd(), "sample_config.yaml"),
+        ]
+
+        for path in sample_config_paths:
+            if os.path.exists(path):
+                shutil.copy(path, target_path)
+                print(f"Generated sample config file at: {target_path}")
+                print(
+                    "\nEdit this file with your Matrix and Meshtastic settings before running mmrelay."
+                )
+                return True
+
         print("Error: Could not find sample_config.yaml")
         return False

mmrelay/setup_utils.py

@@ -5,6 +5,8 @@ This module provides simple functions for managing the systemd user service
 and generating configuration files.
 """
 
+import importlib.resources
+
 # Import version from package
 import os
 import shutil
@@ -12,6 +14,8 @@ import subprocess
 import sys
 from pathlib import Path
 
+from mmrelay.tools import get_service_template_path
+
 
 def get_executable_path():
     """Get the full path to the mmrelay executable.
@@ -103,16 +107,31 @@ def get_template_service_path():
         os.path.join(sys.prefix, "share", "mmrelay", "mmrelay.service"),
         os.path.join(sys.prefix, "share", "mmrelay", "tools", "mmrelay.service"),
         # Check in the user site-packages location
-        os.path.join(os.path.expanduser("~"), ".local", "share", "mmrelay", "mmrelay.service"),
-        os.path.join(os.path.expanduser("~"), ".local", "share", "mmrelay", "tools", "mmrelay.service"),
+        os.path.join(
+            os.path.expanduser("~"), ".local", "share", "mmrelay", "mmrelay.service"
+        ),
+        os.path.join(
+            os.path.expanduser("~"),
+            ".local",
+            "share",
+            "mmrelay",
+            "tools",
+            "mmrelay.service",
+        ),
         # Check one level up from the package directory
         os.path.join(os.path.dirname(package_dir), "tools", "mmrelay.service"),
         # Check two levels up from the package directory (for development)
-        os.path.join(os.path.dirname(os.path.dirname(package_dir)), "tools", "mmrelay.service"),
+        os.path.join(
+            os.path.dirname(os.path.dirname(package_dir)), "tools", "mmrelay.service"
+        ),
         # Check in the repository root (for development)
-        os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))), "tools", "mmrelay.service"),
+        os.path.join(
+            os.path.dirname(os.path.dirname(os.path.dirname(__file__))),
+            "tools",
+            "mmrelay.service",
+        ),
         # Check in the current directory (fallback)
-        os.path.join(os.getcwd(), "tools", "mmrelay.service")
+        os.path.join(os.getcwd(), "tools", "mmrelay.service"),
     ]
 
     # Try each path until we find one that exists
@@ -136,8 +155,10 @@ def get_template_service_content():
     Returns:
         str: The content of the template service file, or a default template if not found.
     """
-    template_path = get_template_service_path()
-    if template_path:
+    # Use the helper function to get the service template path
+    template_path = get_service_template_path()
+
+    if template_path and os.path.exists(template_path):
         # Read the template from file
         try:
             with open(template_path, "r") as f:
@@ -146,6 +167,28 @@ def get_template_service_content():
         except Exception as e:
             print(f"Error reading service template file: {e}")
 
+    # If the helper function failed, try using importlib.resources directly
+    try:
+        service_template = (
+            importlib.resources.files("mmrelay.tools")
+            .joinpath("mmrelay.service")
+            .read_text()
+        )
+        return service_template
+    except (FileNotFoundError, ImportError, OSError) as e:
+        print(f"Error accessing mmrelay.service via importlib.resources: {e}")
+
+        # Fall back to the file path method
+        template_path = get_template_service_path()
+        if template_path:
+            # Read the template from file
+            try:
+                with open(template_path, "r") as f:
+                    service_template = f.read()
+                return service_template
+            except Exception as e:
+                print(f"Error reading service template file: {e}")
+
     # If we couldn't find or read the template file, use a default template
     print("Using default service template")
     return """[Unit]
@@ -154,7 +197,7 @@ After=network-online.target
 Wants=network-online.target
 
 [Service]
-Type=idle
+Type=simple
 # The mmrelay binary can be installed via pipx or pip
 ExecStart=%h/.local/bin/mmrelay --config %h/.mmrelay/config.yaml --logfile %h/.mmrelay/logs/mmrelay.log
 WorkingDirectory=%h/.mmrelay
@@ -310,6 +353,69 @@ def service_needs_update():
     return False, "Service file is up to date"
 
 
+def check_loginctl_available():
+    """Check if loginctl is available on the system.
+
+    Returns:
+        bool: True if loginctl is available, False otherwise.
+    """
+    try:
+        result = subprocess.run(
+            ["which", "loginctl"],
+            check=False,
+            capture_output=True,
+            text=True,
+        )
+        return result.returncode == 0
+    except Exception:
+        return False
+
+
+def check_lingering_enabled():
+    """Check if user lingering is enabled.
+
+    Returns:
+        bool: True if lingering is enabled, False otherwise.
+    """
+    try:
+        username = os.environ.get("USER", os.environ.get("USERNAME"))
+        result = subprocess.run(
+            ["loginctl", "show-user", username, "--property=Linger"],
+            check=False,
+            capture_output=True,
+            text=True,
+        )
+        return result.returncode == 0 and "Linger=yes" in result.stdout
+    except Exception:
+        return False
+
+
+def enable_lingering():
+    """Enable user lingering using sudo.
+
+    Returns:
+        bool: True if lingering was enabled successfully, False otherwise.
+    """
+    try:
+        username = os.environ.get("USER", os.environ.get("USERNAME"))
+        print(f"Enabling lingering for user {username}...")
+        result = subprocess.run(
+            ["sudo", "loginctl", "enable-linger", username],
+            check=False,
+            capture_output=True,
+            text=True,
+        )
+        if result.returncode == 0:
+            print("Lingering enabled successfully")
+            return True
+        else:
+            print(f"Error enabling lingering: {result.stderr}")
+            return False
+    except Exception as e:
+        print(f"Error enabling lingering: {e}")
+        return False
+
+
 def install_service():
     """Install or update the MMRelay user service."""
     # Check if service already exists
@@ -355,6 +461,27 @@ def install_service():
 
     # We don't need to validate the config here as it will be validated when the service starts
 
+    # Check if loginctl is available
+    loginctl_available = check_loginctl_available()
+    if loginctl_available:
+        # Check if user lingering is enabled
+        lingering_enabled = check_lingering_enabled()
+        if not lingering_enabled:
+            print(
+                "\nUser lingering is not enabled. This is required for the service to start automatically at boot."
+            )
+            print(
+                "Lingering allows user services to run even when you're not logged in."
+            )
+            if (
+                input(
+                    "Do you want to enable lingering for your user? (requires sudo) (y/n): "
+                )
+                .lower()
+                .startswith("y")
+            ):
+                enable_lingering()
+
     # Check if the service is already enabled
     service_enabled = is_service_enabled()
     if service_enabled:
@@ -417,6 +544,8 @@ def install_service():
     print("\nService Status Summary:")
     print(f"  Service File: {service_path}")
     print(f"  Enabled at Boot: {'Yes' if service_enabled else 'No'}")
+    if loginctl_available:
+        print(f"  User Lingering: {'Yes' if check_lingering_enabled() else 'No'}")
     print(f"  Currently Running: {'Yes' if is_service_active() else 'No'}")
     print("\nService Management Commands:")
     print_service_commands()

mmrelay/tools/__init__.py

@@ -0,0 +1,28 @@
+"""Tools and resources for MMRelay."""
+
+import importlib.resources
+import pathlib
+
+
+def get_sample_config_path():
+    """Get the path to the sample config file."""
+    try:
+        # For Python 3.9+
+        return str(
+            importlib.resources.files("mmrelay.tools").joinpath("sample_config.yaml")
+        )
+    except AttributeError:
+        # Fallback for older Python versions
+        return str(pathlib.Path(__file__).parent / "sample_config.yaml")
+
+
+def get_service_template_path():
+    """Get the path to the service template file."""
+    try:
+        # For Python 3.9+
+        return str(
+            importlib.resources.files("mmrelay.tools").joinpath("mmrelay.service")
+        )
+    except AttributeError:
+        # Fallback for older Python versions
+        return str(pathlib.Path(__file__).parent / "mmrelay.service")

mmrelay/tools/mmrelay.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=A Meshtastic <=> Matrix Relay
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+# The mmrelay binary can be installed via pipx or pip
+ExecStart=%h/.local/bin/mmrelay --config %h/.mmrelay/config.yaml --logfile %h/.mmrelay/logs/mmrelay.log
+WorkingDirectory=%h/.mmrelay
+Restart=on-failure
+RestartSec=10
+Environment=PYTHONUNBUFFERED=1
+# Ensure both pipx and pip environments are properly loaded
+Environment=PATH=%h/.local/bin:%h/.local/pipx/venvs/mmrelay/bin:/usr/local/bin:/usr/bin:/bin
+
+[Install]
+WantedBy=default.target

mmrelay/tools/sample_config.yaml

@@ -0,0 +1,64 @@
+matrix:
+  homeserver: https://example.matrix.org
+  access_token: reaalllllyloooooongsecretttttcodeeeeeeforrrrbot # See: https://t2bot.io/docs/access_tokens/
+  bot_user_id: "@botuser:example.matrix.org"
+
+matrix_rooms: # Needs at least 1 room & channel, but supports all Meshtastic channels
+  - id: "#someroomalias:example.matrix.org" # Matrix room aliases & IDs supported
+    meshtastic_channel: 0
+  - id: "!someroomid:example.matrix.org"
+    meshtastic_channel: 2
+
+meshtastic:
+  connection_type: serial # Choose either "tcp", "serial", or "ble"
+  serial_port: /dev/ttyUSB0 # Only used when connection is "serial"
+  host: meshtastic.local # Only used when connection is "tcp"
+  ble_address: AA:BB:CC:DD:EE:FF # Only used when connection is "ble" - Uses either an address or name from a `meshtastic --ble-scan`
+  meshnet_name: Your Meshnet Name # This is displayed in full on Matrix, but is truncated when sent to a Meshnet
+  broadcast_enabled: true # Must be set to true to enable Matrix to Meshtastic messages
+  detection_sensor: true # Must be set to true to forward messages of Meshtastic's detection sensor module
+  plugin_response_delay: 3 # Default response delay in seconds for plugins that respond on the mesh;
+  relay_reactions: true # Defaults to false, set to true to enable relay reactions between platforms
+
+logging:
+  level: info
+  #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
+#  msg_map: # The message map is necessary for the relay_reactions functionality. If `relay_reactions` is set to false, nothing will be saved to the message map.
+#    msgs_to_keep: 500 # If set to 0, it will not delete any messages; Defaults to 500
+#    wipe_on_restart: true # Clears out the message map when the relay is restarted; Defaults to False
+
+# These are core Plugins - Note: Some plugins are experimental and some need maintenance.
+plugins:
+  ping:
+    active: true
+    #channels: [2,3,5] # List of channels the plugin will respond to; DMs are always processed if the plugin is active
+  weather:
+    active: true
+    units: imperial # Options: metric, imperial - Default is metric
+    #channels: [] # Empty list, will only respond to DMs
+  nodes:
+    active: true
+    # Does not need to specify channels, as it's a Matrix-only plugin
+
+#community-plugins:
+#  sample_plugin:
+#    active: true
+#    repository: https://github.com/username/sample_plugin.git
+#    tag: master
+#  advanced_plugin:
+#    active: false
+#    repository: https://github.com/username/advanced_plugin.git
+#    tag: v1.2.0
+
+#custom-plugins:
+#  my_custom_plugin:
+#    active: true
+#  another_custom_plugin:
+#    active: false

{mmrelay-1.0.6.dist-info → mmrelay-1.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.0.6
+Version: 1.0.7
 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
@@ -68,7 +68,7 @@ For pipx installation instructions, see: [pipx installation guide](https://pipx.
 
 - **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
 - **Existing Users**: See [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
-- **Configuration**: Review [sample_config.yaml](sample_config.yaml) for examples
+- **Configuration**: Review [sample_config.yaml](src/mmrelay/tools/sample_config.yaml) for examples
 
 ### Command-Line Options
 

{mmrelay-1.0.6.dist-info → mmrelay-1.0.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 mmrelay/__init__.py,sha256=8fghAZAeSUb8uIaiit0FGNUWI0ZsBR__QbXNwqNbGtw,588
-mmrelay/cli.py,sha256=yBYOkCwGYDJ2gRKPoPltxB_PydX1CPNUerVJHcNuHTo,12355
+mmrelay/cli.py,sha256=hdPTlcGsXTJC9GEUiScG7b3IFp02B3lwhqgwFpU3NsM,13835
 mmrelay/config.py,sha256=5VZag8iSc5yLQgvwI76bbpizbtqag74cHnfXCrWHNyA,7910
 mmrelay/config_checker.py,sha256=UnoHVTXzfdTfFkbmXv9r_Si76v-sxXLb5FOaQSOM45E,4909
 mmrelay/db_utils.py,sha256=DP2YuKBZtV771wo9X-Z7Ww5txfaIR0inWh1K_oVZ7cA,11430
@@ -8,7 +8,7 @@ mmrelay/main.py,sha256=acgBF-DnL0Rs8MmYAfbNHZ9xjqM3Qc0_oKtATN4iOEE,11085
 mmrelay/matrix_utils.py,sha256=GkIVj2bbPHtx1emFMwhEhc1SWHcv4UvkuyZYdb-Wnwo,30511
 mmrelay/meshtastic_utils.py,sha256=Pd0j7mz008ncBDIjRGyHOIb0U3vKq06uXWoJP-csHcQ,23381
 mmrelay/plugin_loader.py,sha256=Gg8E_TKqndMQHiVJwtmlIC-jCgcty-5EsX_5JJ6Onvo,36590
-mmrelay/setup_utils.py,sha256=UZLX944GyiUQPUGNGNDwLocgShA8SzOJtvfntEu821A,16060
+mmrelay/setup_utils.py,sha256=N6qdScHKHEMFKDmT1l7dcLDPNTusZXPkyxrLXjFLhRI,19910
 mmrelay/plugins/__init__.py,sha256=KVMQIXRhe0wlGj4O3IZ0vOIQRKFkfPYejHXhJL17qrc,51
 mmrelay/plugins/base_plugin.py,sha256=hv21tSEYG-AB36aLAFdW9DDKm0NOTRNPpGIO5F3i1ts,8633
 mmrelay/plugins/debug_plugin.py,sha256=Jziht9Nj_bRO6Rmy7TjfBXaYo5eM3XsenbWFxPpyUs4,443
@@ -21,9 +21,12 @@ mmrelay/plugins/nodes_plugin.py,sha256=RDabzyG5hKG5aYWecsRUcLSjMCCv6Pngmq2Qpld1A
 mmrelay/plugins/ping_plugin.py,sha256=RTRdgDQUSO33lreDTmWsTlI0L1C3FJrXE0KYqfEWYO0,4017
 mmrelay/plugins/telemetry_plugin.py,sha256=8SxWv4BLXMUTbiVaD3MjlMMdQyS7S_1OfLlVNAUMSO0,6306
 mmrelay/plugins/weather_plugin.py,sha256=yoKA_HdFqFEhgYdXqLhvXatLphCyLJFuGUKCR7fILv0,8546
-mmrelay-1.0.6.dist-info/licenses/LICENSE,sha256=yceWauM1c0-FHxVplsD7W1-AbSeRaUNlmqT4UO1msBU,1073
-mmrelay-1.0.6.dist-info/METADATA,sha256=V_JcF794O_pNB39Bm3K1TxVpB3C5f1lWYGQu4s3j3Dc,6987
-mmrelay-1.0.6.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-mmrelay-1.0.6.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
-mmrelay-1.0.6.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
-mmrelay-1.0.6.dist-info/RECORD,,
+mmrelay/tools/__init__.py,sha256=WFjDQjdevgg19_zT6iEoL29rvb1JPqYSd8708Jn5D7A,838
+mmrelay/tools/mmrelay.service,sha256=3vqK1VbfXvVftkTrTEOan77aTHeOT36hIAL7HqJsmTg,567
+mmrelay/tools/sample_config.yaml,sha256=iGOoVxELUEJwfmpFxyeWXXS0RWNsErnf8-6LXyIwH2k,3052
+mmrelay-1.0.7.dist-info/licenses/LICENSE,sha256=yceWauM1c0-FHxVplsD7W1-AbSeRaUNlmqT4UO1msBU,1073
+mmrelay-1.0.7.dist-info/METADATA,sha256=zhlJoZilGueyloBZ-n7t7bg2QaMi_xSwjEQXb7SKGZM,7005
+mmrelay-1.0.7.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+mmrelay-1.0.7.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
+mmrelay-1.0.7.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
+mmrelay-1.0.7.dist-info/RECORD,,