p3lib 1.1.93__tar.gz → 1.1.95__tar.gz

{p3lib-1.1.93 → p3lib-1.1.95}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.93
+Version: 1.1.95
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.93 → p3lib-1.1.95}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = p3lib
-version = 1.1.93
+version = 1.1.95
 author = Paul Austen
 author_email = pausten.os@gmail.com
 description = A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.

{p3lib-1.1.93 → p3lib-1.1.95}/src/p3lib/boot_manager.py

@@ -27,13 +27,16 @@ class BootManager(object):
         parser.add_argument(BootManager.CHECK_CMD_OPT,   help="Check the status of an auto started icons_gw instance.", action="store_true", default=False)
 
     @staticmethod
-    def HandleOptions(uio, options, enable_syslog):
+    def HandleOptions(uio, options, enable_syslog, appName=None, restartSeconds=1):
         """@brief Handle one of the bot manager command line options if the 
                   user passed it on the cmd line.
            @param uio A UIO instance.
            @param options As returned from parser.parse_args() where parser 
                           is an instance of argparse.ArgumentParser.
            @param enable_syslog True to enable systemd syslog output.
+           @param appName The name of the app. This is used as the service name. If not set then
+                          the name of the initially executed python file is used.
+           @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1).
            @return True if handled , False if not."""
         handled = False
         if options.check_auto_start:
@@ -41,7 +44,7 @@ class BootManager(object):
             handled = True
             
         elif options.enable_auto_start:
-            BootManager.EnableAutoStart(uio, enable_syslog)
+            BootManager.EnableAutoStart(uio, enable_syslog, appName, restartSeconds)
             handled = True
             
         elif options.disable_auto_start:
@@ -51,9 +54,16 @@ class BootManager(object):
         return handled
 
     @staticmethod
-    def EnableAutoStart(uio, enable_syslog):
-        """@brief Enable this program to auto start when the computer on which it is installed starts."""
-        bootManager = BootManager(uio=uio, ensureRootUser=True)
+    def EnableAutoStart(uio, enable_syslog, appName, restartSeconds):
+        """@brief Enable this program to auto start when the computer on which it is installed starts.
+           @param uio A UIO instance.
+           @param options As returned from parser.parse_args() where parser 
+                          is an instance of argparse.ArgumentParser.
+           @param enable_syslog True to enable systemd syslog output.
+           @param appName The name of the app. This is used as the service name. If not set then
+                          the name of the initially executed python file is used.
+           @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1)."""
+        bootManager = BootManager(uio=uio, ensureRootUser=True, appName=appName, restartSeconds=restartSeconds)
         arsString = " ".join(sys.argv)
         bootManager.add(argString=arsString, enableSyslog=enable_syslog)
 
@@ -72,7 +82,7 @@ class BootManager(object):
             for line in lines:
                 uio.info(line)
         
-    def __init__(self, uio=None, allowRootUser=True, ensureRootUser=False):
+    def __init__(self, uio=None, allowRootUser=True, ensureRootUser=False, appName=None, restartSeconds=1):
         """@brief Constructor
            @param uio A UIO instance to display user output. If unset then no output
                   is displayed to user.
@@ -81,13 +91,16 @@ class BootManager(object):
                   ensuring programs are started up when a machine boots up 
                   the installed program should be installed for the root 
                   user on Linux systems.
-           @param ensureRootUser If True the current user must be root user (Linux systems)."""
+           @param ensureRootUser If True the current user must be root user (Linux systems).
+           @param appName The name of the app. This is used as the service name. If not set then
+                          the name of the initially executed python file is used.
+           @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1)."""
         self._uio = uio
         self._allowRootUser=allowRootUser
         self._osName = platform.system()
         self._platformBootManager = None
         if self._osName == BootManager.LINUX_OS_NAME:
-            self._platformBootManager = LinuxBootManager(uio, self._allowRootUser, ensureRootUser)
+            self._platformBootManager = LinuxBootManager(uio, self._allowRootUser, ensureRootUser, appName, restartSeconds)
         else:
             raise Exception("{} is an unsupported OS.".format(self._osName) )
 
@@ -155,11 +168,14 @@ class LinuxBootManager(object):
             raise Exception(f"{serviceFolder} folder not found.")
         return serviceFolder
 
-    def __init__(self, uio, allowRootUser, ensureRootUser):
+    def __init__(self, uio, allowRootUser, ensureRootUser, appName, restartSeconds):
         """@brief Constructor
            @param uio A UIO instance to display user output. If unset then no output is displayed to user.
            @param allowRootUser If True then allow root user to to auto start programs.
-           @param ensureRootUser If True the current user must be root user."""
+           @param ensureRootUser If True the current user must be root user.
+           @param appName The name of the app. This is used as the systemd service name. If not set then
+                          the name of the initially executed python file is used.
+           @param restartSeconds The number of seconds to sleep before restarting a service that has stopped."""
         self._uio = uio
         self._logFile = None
         self._allowRootUser=allowRootUser
@@ -180,7 +196,8 @@ class LinuxBootManager(object):
             self._cmdLinePrefix = self._systemCtlBin
         self._username = getpass.getuser()
         self._serviceFolder = LinuxBootManager.GetServiceFolder(self._rootMode)
-        self._appName = None
+        self._appName = appName
+        self._restartSeconds = restartSeconds
 
     def _getInstallledStartupScript(self):
         """@brief Get the startup script full path. The startup script must be
@@ -252,18 +269,25 @@ class LinuxBootManager(object):
         if not os.path.isdir(exePath):
             self._fatalError("{} path not found".format(exePath))
 
-        appName = os.path.basename(exeFile)
-        if len(appName) == 0:
-            self._fatalError("No app found to execute.")
+        # If the appName was set in the constructor then use this.
+        if self._appName:
+            appName = self._appName
 
-        absApp = os.path.join(exePath, appName)
-        if not os.path.isfile( absApp ):
-            self._fatalError("{} file not found.".format(absApp) )
+        # Else we use the initially executed python file.
+        else:
 
-        appName = appName.replace(".py", "")
-        if self._rootMode:
-            # We can only save to /var/log/ is we are root user.
-            self._logFile = os.path.join(LinuxBootManager.LOG_PATH, appName)
+            appName = os.path.basename(exeFile)
+            if len(appName) == 0:
+                self._fatalError("No app found to execute.")
+
+            absApp = os.path.join(exePath, appName)
+            if not os.path.isfile( absApp ):
+                self._fatalError("{} file not found.".format(absApp) )
+
+            appName = appName.replace(".py", "")
+            if self._rootMode:
+                # We can only save to /var/log/ is we are root user.
+                self._logFile = os.path.join(LinuxBootManager.LOG_PATH, appName)
 
         return (appName, absApp)
 
@@ -302,7 +326,7 @@ class LinuxBootManager(object):
         lines.append("[Service]")
         lines.append("Type=simple")
         lines.append("Restart=always")
-        lines.append("RestartSec=1")
+        lines.append(f"RestartSec={self._restartSeconds}")
         if enableSyslog:
             lines.append("StandardOutput=syslog")
             lines.append("StandardError=syslog")

{p3lib-1.1.93 → p3lib-1.1.95}/src/p3lib/helper.py

@@ -9,7 +9,6 @@ import platform
 import json
 import traceback
 import socket
-import platform
 
 def initArgs(parser, lastCmdLineArg=None, checkHostArg=True):
     """This method is responsible for

{p3lib-1.1.93 → p3lib-1.1.95}/src/p3lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.93
+Version: 1.1.95
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen