dtPyAppFramework 2.4__tar.gz → 3.0__tar.gz

{dtpyappframework-2.4/src/dtPyAppFramework.egg-info → dtpyappframework-3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dtPyAppFramework
-Version: 2.4
+Version: 3.0
 Summary: A Python library for common features in application development.
 Author-email: Digital-Thought <dev@digital-thought.org>
 Maintainer-email: Digital-Thought <dev@digital-thought.org>
@@ -49,18 +49,20 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENCE.txt
-Requires-Dist: PyYaml
-Requires-Dist: colorlog
-Requires-Dist: psutil
-Requires-Dist: pybase64
-Requires-Dist: boto3
-Requires-Dist: cryptography
+Requires-Dist: PyYaml~=6.0.2
+Requires-Dist: colorlog~=6.9.0
+Requires-Dist: psutil~=6.1.0
+Requires-Dist: pybase64~=1.4.0
+Requires-Dist: boto3~=1.35.54
+Requires-Dist: cryptography~=44.0.0
 Requires-Dist: azure-identity
 Requires-Dist: azure-keyvault-secrets
 Requires-Dist: pytest-mock
 Requires-Dist: pytest-watch
-Requires-Dist: pytest
-Requires-Dist: watchdog
+Requires-Dist: pytest~=8.3.3
+Requires-Dist: watchdog~=6.0.0
+Requires-Dist: azure-core~=1.32.0
+Requires-Dist: pywin32; platform_system == "Windows"
 
 # dtPyAppFramework
 

dtpyappframework-3.0/requirements.txt

@@ -0,0 +1,14 @@
+PyYaml~=6.0.2
+colorlog~=6.9.0
+psutil~=6.1.0
+pybase64~=1.4.0
+boto3~=1.35.54
+cryptography~=44.0.0
+azure-identity
+azure-keyvault-secrets
+pytest-mock
+pytest-watch
+pytest~=8.3.3
+watchdog~=6.0.0
+azure-core~=1.32.0
+pywin32;platform_system == "Windows"

dtpyappframework-3.0/src/dtPyAppFramework/_version.txt

@@ -0,0 +1 @@
+3.0

{dtpyappframework-2.4 → dtpyappframework-3.0}/src/dtPyAppFramework/application.py

@@ -103,21 +103,35 @@ class AbstractApp(object):
         arg_parser.add_argument('--init', action='store_true', required=False, help='Initialise environment')
         arg_parser.add_argument('--add_secret', action='store_true', required=False, help='Add secret to store')
         arg_parser.add_argument('--run', action='store_true', required=False, help='Run Processor')
+        arg_parser.add_argument('--service', action='store_true', required=False, help='Run as Service')
         arg_parser.add_argument('--single_folder', action='store_true', required=False, help='Keeps all Directories in a single folder')
+        arg_parser.add_argument('--working_dir', action='store', type=str, required=False, help="Sets the Working Directory")
+
         self.define_args(arg_parser)
         # Check specific states and add corresponding arguments
         opts, rem_args = arg_parser.parse_known_args()
 
+        if opts.working_dir:
+            os.chdir(opts.working_dir)
+
         if opts.single_folder:
             os.environ['DEV_MODE'] = "True"
 
+        if opts.service:
+            arg_parser.add_argument('--install', action='store_true')
+
         if opts.init:
             arg_parser.add_argument('--password', action='store', type=str, required=False,
                                     help="Secrets Store password")
-
         elif opts.add_secret:
             arg_parser.add_argument('--name', action='store', type=str, required=True, help="Secret Name")
-            arg_parser.add_argument('--value', action='store', type=str, required=True, help="Secret Value")
+
+            group = arg_parser.add_mutually_exclusive_group(required=True)
+            group.add_argument('--value', action='store', type=str, help="Secret Value")
+            group.add_argument('--file', action='store', type=str, help="File to add to secret")
+
+            arg_parser.add_argument('--store_as', action='store', type=str, default='raw', choices=['raw', 'base64'],
+                                    help="Store file as either base64 or raw")
 
     def exit(self):
         self.exiting()

{dtpyappframework-2.4 → dtpyappframework-3.0}/src/dtPyAppFramework/process/__init__.py

@@ -6,11 +6,21 @@ from .. import resources
 from multiprocessing import current_process
 from argparse import ArgumentParser
 from .multiprocessing import MultiProcessingManager
-
+import platform
 import sys
 import os
 import logging
-import argparse
+import base64
+import threading
+import signal
+import time
+
+if platform.system() == "Windows":
+    try:
+        from dtPyAppFramework.process.windows_service import call_service
+    except ImportError as ex:
+        logging.error("pywin32 is not installed.")
+        raise ex
 
 
 def is_multiprocess_spawned_instance():
@@ -63,6 +73,7 @@ class ProcessManager():
         self.multiprocessing_manager = None
         self.stdout_txt_file = None
         self.stderr_txt_file = None
+        self.running = threading.Event()
 
     def __initialise_spawned_application__(self, parent_log_path, job_id, worker_id, job_name, pipe_registry):
         """
@@ -112,10 +123,10 @@ class ProcessManager():
             stdout_txt = '{}/stdout.txt'.format(self.log_path, self.application_paths.app_short_name)
             stderr_txt = '{}/stderr.txt'.format(self.log_path, self.application_paths.app_short_name)
 
-            stdout_txt_file = open(stdout_txt, mode='w', buffering=1)
-            stderr_txt_file = open(stderr_txt, mode='w', buffering=1)
-            sys.stdout = stdout_txt_file
-            sys.stderr = stderr_txt_file
+            self.stdout_txt_file = open(stdout_txt, mode='w', buffering=1)
+            self.stderr_txt_file = open(stderr_txt, mode='w', buffering=1)
+            sys.stdout = self.stdout_txt_file
+            sys.stderr = self.stderr_txt_file
 
     def initialise_application(self, arg_parser):
         """
@@ -147,16 +158,22 @@ class ProcessManager():
 
                 if args.add_secret:
                     self.__add_secret__(args)
+                elif args.service:
+                    if platform.system() == "Windows":
+                        sys.argv = [sys.argv[0]]
+                        call_service(svc_name=self.short_name, svc_display_name=self.full_name,
+                                     svc_description=self.description, main_function=self.__main__,
+                                     exit_function=self.call_shutdown)
+
                 else:
+                    signal.signal(signal.SIGINT, self.call_shutdown)
+                    signal.signal(signal.SIGTERM, self.call_shutdown)
                     self.__main__(args)
 
         except KeyboardInterrupt as kbi:
             logging.warning('(KeyboardInterrupt) Exiting application.')
-            if self.exit_procedure:
-                self.exit_procedure()
-            if not self.console_app:
-                self.stdout_txt_file.close()
-                self.stderr_txt_file.close()
+        except Exception as ex:
+            logging.exception(str(ex))
 
     def load_config(self):
         """
@@ -173,11 +190,46 @@ class ProcessManager():
             args: Parsed command-line arguments.
         """
         try:
-            self.application_settings.secrets_manager.set_secret(args.name, args.value)
+            name = args.name
+            value = None
+            if args.value:
+                value = args.value
+            if args.file:
+                file_path = args.file
+                if not os.path.exists(file_path):
+                    raise FileNotFoundError(f'The file "{file_path}" could not be found.')
+
+                if args.store_as == 'raw':
+                    with open(file_path, 'r') as file:
+                        file_content = file.read()
+                    value = file_content
+                elif args.store_as == 'base64':
+                    with open(file_path, 'rb') as file:
+                        file_content = file.read()
+                    value = base64.b64encode(file_content).decode('utf-8')
+                else:
+                    raise ValueError(f'Invalid store_as value: {args.store_as}')
+
+            if value is None:
+                raise ValueError(f'No "value" was specified for {name}')
+
+            settings.SecretsManager().set_secret(name, value)
+            logging.info(f'Added secret "{name}" to Secret Store.')
+            settings.Settings().close()
         except Exception as ex:
             logging.error(f'Error occurred while adding secret {args.name}.  Error: {str(ex)}')
             raise ex
 
+    def handle_shutdown(self):
+        if self.exit_procedure:
+            self.exit_procedure()
+        if not self.console_app:
+            self.stdout_txt_file.close()
+            self.stderr_txt_file.close()
+
+    def call_shutdown(self, signum=None, frame=None):
+        self.running.clear()
+
     def __main__(self, args):
         """
         Execute the main procedure of the application.
@@ -185,8 +237,13 @@ class ProcessManager():
         Args:
             args: Parsed command-line arguments.
         """
+        self.running.set()
         self.load_config()
         self.main_procedure(args)
 
-        if self.exit_procedure:
-            self.exit_procedure()
+        while self.running.is_set():
+            time.sleep(0.5)
+
+        self.handle_shutdown()
+
+

dtpyappframework-3.0/src/dtPyAppFramework/process/windows_service.py

@@ -0,0 +1,61 @@
+import platform
+import logging
+import sys
+
+if platform.system() == "Windows":
+    try:
+        import win32service
+        import socket
+        import win32serviceutil
+        import win32event
+        import servicemanager
+    except ImportError as ex:
+        logging.error("pywin32 is not installed.")
+        raise ex
+
+
+class WindowsService(win32serviceutil.ServiceFramework):
+    _svc_name_ = None
+    _svc_display_name_ = None
+    _svc_description_ = None
+    _running_function_ = None
+    _stop_function_ = None
+
+    def __init__(self, args):
+        win32serviceutil.ServiceFramework.__init__(self, args)
+        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
+        socket.setdefaulttimeout(60)
+        self.args = args
+
+    def SvcStop(self):
+        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
+        win32event.SetEvent(self.hWaitStop)
+        self._stop_function_()
+
+    def SvcDoRun(self):
+        try:
+            rc = None
+            logging.info(f"Service {self._svc_name_} is starting...")
+            servicemanager.LogInfoMsg(f"Service {self._svc_name_} is starting...")
+            self._running_function_(self.args)
+            while rc != win32event.WAIT_OBJECT_0:
+                rc = win32event.WaitForSingleObject(self.hWaitStop, 5000)
+        except Exception as ex:
+            logging.exception(str(ex))
+            raise ex
+        logging.info(f"Service {self._svc_name_} is stopping...")
+        servicemanager.LogInfoMsg(f"Service {self._svc_name_} is stopping...")
+
+def call_service(svc_name, svc_display_name, svc_description, main_function, exit_function):
+    WindowsService._svc_name_ = svc_name
+    WindowsService._svc_display_name_ = svc_display_name
+    WindowsService._svc_description_ = svc_description
+    WindowsService._running_function_ = main_function
+    WindowsService._stop_function_ = exit_function
+
+    if len(sys.argv) == 1:
+        servicemanager.Initialize()
+        servicemanager.PrepareToHostSingle(WindowsService)
+        servicemanager.StartServiceCtrlDispatcher()
+    else:
+        win32serviceutil.HandleCommandLine(WindowsService)

{dtpyappframework-2.4 → dtpyappframework-3.0}/src/dtPyAppFramework/settings/secrets/local_secret_store.py

@@ -4,6 +4,8 @@ import sys
 import logging
 import re
 import pybase64
+import yaml
+import base64
 
 from .secret_store import AbstractSecretStore, SecretsStoreException
 from itertools import cycle
@@ -64,9 +66,45 @@ class LocalSecretStore(AbstractSecretStore):
             self.store_available = True
             self.store_read_only = not self.__is_writeable()
             logging.info(f'Successfully opened Secrets Store: {self.store_path}')
+            self.__check_auto_imports(root_store_path)
         except Exception as ex:
             raise SecretsStoreException(f'Failed to open Secrets Store: {self.store_path}. Error: {str(ex)}')
 
+    def __check_auto_imports(self, root_store_path):
+        auto_yaml = os.path.join(root_store_path, 'secrets.yaml')
+        if os.path.exists(auto_yaml):
+            print(f'Performing Auto-Import of Secrets from {auto_yaml}')
+            with open(auto_yaml, 'r', encoding='UTF-8') as auto_yaml_file:
+                secrets = yaml.safe_load(auto_yaml_file)
+                for entry in secrets['secrets']:
+                    name = entry.get('name')
+                    value = entry.get('value')
+                    secret_file = entry.get('file')
+                    store_as = entry.get('store_as')
+
+                    if secret_file is not None:
+                        if os.path.exists(secret_file):
+                            if store_as == 'raw':
+                                with open(secret_file, 'r') as file:
+                                    file_content = file.read()
+                                value = file_content
+                            elif store_as == 'base64':
+                                with open(secret_file, 'rb') as file:
+                                    file_content = file.read()
+                                value = base64.b64encode(file_content).decode('utf-8')
+                            else:
+                                print(f'Unsupported "store_as" value of {store_as} for {name}', file=sys.stderr)
+                        else:
+                            print(f'The file "{secret_file}" specified for {name} does not exist', file=sys.stderr)
+
+                    if value is not None:
+                        self.set_secret(name, value)
+                        print(f'Imported Secret: {name}')
+                    else:
+                        print(f'Missing "value" for {name}. Not imported.', file=sys.stderr)
+
+            os.remove(auto_yaml)
+
     def __guid(self):
         """
         Generate a unique identifier based on the machine and store path.
@@ -155,7 +193,6 @@ class LocalSecretStore(AbstractSecretStore):
         self.__set_index(index)
 
     def __set_index(self, index: list):
-        logging.info(index)
         self.store.set(key=f'{self.store_name}.INDEX', value=json.dumps(index))
 
     def get_index(self) -> list:

{dtpyappframework-2.4 → dtpyappframework-3.0/src/dtPyAppFramework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dtPyAppFramework
-Version: 2.4
+Version: 3.0
 Summary: A Python library for common features in application development.
 Author-email: Digital-Thought <dev@digital-thought.org>
 Maintainer-email: Digital-Thought <dev@digital-thought.org>
@@ -49,18 +49,20 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENCE.txt
-Requires-Dist: PyYaml
-Requires-Dist: colorlog
-Requires-Dist: psutil
-Requires-Dist: pybase64
-Requires-Dist: boto3
-Requires-Dist: cryptography
+Requires-Dist: PyYaml~=6.0.2
+Requires-Dist: colorlog~=6.9.0
+Requires-Dist: psutil~=6.1.0
+Requires-Dist: pybase64~=1.4.0
+Requires-Dist: boto3~=1.35.54
+Requires-Dist: cryptography~=44.0.0
 Requires-Dist: azure-identity
 Requires-Dist: azure-keyvault-secrets
 Requires-Dist: pytest-mock
 Requires-Dist: pytest-watch
-Requires-Dist: pytest
-Requires-Dist: watchdog
+Requires-Dist: pytest~=8.3.3
+Requires-Dist: watchdog~=6.0.0
+Requires-Dist: azure-core~=1.32.0
+Requires-Dist: pywin32; platform_system == "Windows"
 
 # dtPyAppFramework
 

{dtpyappframework-2.4 → dtpyappframework-3.0}/src/dtPyAppFramework.egg-info/SOURCES.txt

@@ -29,6 +29,7 @@ src/dtPyAppFramework/misc/yaml/__init__.py
 src/dtPyAppFramework/paths/__init__.py
 src/dtPyAppFramework/process/__init__.py
 src/dtPyAppFramework/process/multiprocessing.py
+src/dtPyAppFramework/process/windows_service.py
 src/dtPyAppFramework/resources/__init__.py
 src/dtPyAppFramework/settings/__init__.py
 src/dtPyAppFramework/settings/settings_reader.py

dtpyappframework-3.0/src/dtPyAppFramework.egg-info/requires.txt

@@ -0,0 +1,16 @@
+PyYaml~=6.0.2
+colorlog~=6.9.0
+psutil~=6.1.0
+pybase64~=1.4.0
+boto3~=1.35.54
+cryptography~=44.0.0
+azure-identity
+azure-keyvault-secrets
+pytest-mock
+pytest-watch
+pytest~=8.3.3
+watchdog~=6.0.0
+azure-core~=1.32.0
+
+[:platform_system == "Windows"]
+pywin32

dtpyappframework-2.4/requirements.txt

@@ -1,12 +0,0 @@
-PyYaml
-colorlog
-psutil
-pybase64
-boto3
-cryptography
-azure-identity
-azure-keyvault-secrets
-pytest-mock
-pytest-watch
-pytest
-watchdog

dtpyappframework-2.4/src/dtPyAppFramework/_version.txt

@@ -1 +0,0 @@
-2.4

dtpyappframework-2.4/src/dtPyAppFramework.egg-info/requires.txt

@@ -1,12 +0,0 @@
-PyYaml
-colorlog
-psutil
-pybase64
-boto3
-cryptography
-azure-identity
-azure-keyvault-secrets
-pytest-mock
-pytest-watch
-pytest
-watchdog