mmrelay 1.0.6__tar.gz → 1.0.7__tar.gz

{mmrelay-1.0.6 → mmrelay-1.0.7}/MANIFEST.in

@@ -3,3 +3,4 @@ include README.md
 include requirements.txt
 include sample_config.yaml
 recursive-include tools *
+recursive-include src/mmrelay/tools *

{mmrelay-1.0.6/src/mmrelay.egg-info → mmrelay-1.0.7}/PKG-INFO

@@ -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 → mmrelay-1.0.7}/README.md

@@ -38,7 +38,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 → mmrelay-1.0.7}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mmrelay
-version = 1.0.6
+version = 1.0.7
 author = Geoff Whittington, Jeremiah K., and contributors
 author_email = jeremiahk@gmx.com
 description = Bridge between Meshtastic mesh networks and Matrix chat rooms
@@ -39,6 +39,9 @@ include_package_data = True
 [options.packages.find]
 where = src
 
+[options.package_data]
+mmrelay.tools = *.yaml, *.service
+
 [options.entry_points]
 console_scripts = 
 	mmrelay = mmrelay.cli:main

{mmrelay-1.0.6 → mmrelay-1.0.7}/src/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-1.0.6 → mmrelay-1.0.7}/src/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-1.0.7/src/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-1.0.6 → mmrelay-1.0.7/src/mmrelay}/tools/mmrelay.service

@@ -4,7 +4,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

{mmrelay-1.0.6 → mmrelay-1.0.7/src/mmrelay.egg-info}/PKG-INFO

@@ -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 → mmrelay-1.0.7}/src/mmrelay.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ MANIFEST.in
 README.md
 pyproject.toml
 requirements.txt
-sample_config.yaml
 setup.cfg
 src/mmrelay/__init__.py
 src/mmrelay/cli.py
@@ -34,4 +33,6 @@ src/mmrelay/plugins/nodes_plugin.py
 src/mmrelay/plugins/ping_plugin.py
 src/mmrelay/plugins/telemetry_plugin.py
 src/mmrelay/plugins/weather_plugin.py
-tools/mmrelay.service
+src/mmrelay/tools/__init__.py
+src/mmrelay/tools/mmrelay.service
+src/mmrelay/tools/sample_config.yaml