PyELSSA 0.1.0__py3-none-any.whl

PyELSSA/__init__.py

@@ -0,0 +1,28 @@
+#
+# -*- coding: utf-8  -*-
+#=================================================================
+# Created by: Jieming Ye
+# Created on: Sep 2026
+# Last Modified: XX/XX/2026
+#=================================================================
+# Copyright (c) 2026 [Jieming Ye]
+#
+# This Python source code is licensed under the 
+# Open Source Non-Commercial License (OSNCL) v1.0
+# See LICENSE for details.
+#=================================================================
+"""
+Python on ELSSA: PyELSSA Package
+
+"""
+#=================================================================
+# VERSION CONTROL
+# V1.0.0 (Jieming Ye) - Initial Version
+#=================================================================
+# Set Information Variable
+__author__ = "Jieming Ye"
+__copyright__ = "Copyright 2026, Engineering Services"
+__credits__ = "Jieming Ye"
+__version__ = "0.1.0"
+__email__ = "jieming.ye@networkrail.co.uk"
+__status__ = "Beta Version"

PyELSSA/configuration.py

@@ -0,0 +1,325 @@
+#
+# -*- coding: utf-8  -*-
+#=================================================================
+# Created by: Jieming Ye
+# Created on: July 2026
+# Last Modified: July 2026
+#=================================================================
+# Copyright (c) 2026 [Jieming Ye]
+#
+# This Python source code is licensed under the 
+# Open Source Non-Commercial License (OSNCL) v1.0
+# See LICENSE for details.
+#=================================================================
+"""
+This scripts contains the functions that control the configuration file settings
+
+"""
+#=================================================================
+# VERSION CONTROL
+# V1.0 (Jieming Ye) - Initial Version
+#
+#=================================================================
+# Set Information Variable
+# N/A
+#=================================================================
+
+import os
+import json
+import importlib
+import requests
+import shutil
+
+from PyELSSA.shared_contents import SharedVariables, SharedMethods, DataFilenames, InternetValidation
+from PyELSSA.shared_msazure_api import AzureWorkflow, AzureCloudID
+
+CONFIG_FILE = SharedVariables.config_file
+
+# initial database system check
+def initial_missing_user_database_check():
+    '''
+    This function doing application database entering checking and returing:
+    FALSE: if the initial database check passed i.e. no missing files.
+    Filenamelist: if the initial database check failed.
+    '''
+    filenamelist = []
+    # check if the database path exist.
+    if not os.path.exists(SharedVariables.database_path_user):
+        for filename in DataFilenames.private_file.values():
+            filenamelist.append(filename)
+        for filename in DataFilenames.public_file.values():
+            filenamelist.append(filename)
+    
+    # loop the database folder and add the missing files into the filename list
+    else:
+        for filename in DataFilenames.private_file.values():
+            file_in_package = os.path.join(SharedVariables.database_path_user, filename)
+            if not os.path.isfile(file_in_package):
+                filenamelist.append(filename)
+        for filename in DataFilenames.public_file.values():
+            file_in_package = os.path.join(SharedVariables.database_path_user, filename)
+            if not os.path.isfile(file_in_package):
+                filenamelist.append(filename)
+
+    # if not empty filename list return filenamelist otherwise False
+    if filenamelist:
+        return filenamelist
+    else:
+        return False
+
+# update the customised database library
+@staticmethod
+def update_database_library(filenamelist: list=None, library: int = 0):
+    '''
+    This function updates the customised database library from GitHub Repo online (if public)
+    or data folder (if private).
+    This will overwrite the existing database file blindly.
+
+    if no input is not provided, this will restore all default database library
+
+    library: (int)
+    default to 0: default library
+    1: user library
+    '''
+    if library == 0:
+        controlled_data_path = SharedVariables.database_path_default
+    else:
+        controlled_data_path = SharedVariables.database_path_user
+
+    print(f"Config Path: '{controlled_data_path}'")
+
+    os.makedirs(controlled_data_path, exist_ok=True)
+    
+    private_file_list = []
+    public_file_list = []
+
+    if filenamelist:
+        for filename in filenamelist:
+            # check if the filename belongs public or private dataset, and update accordingly
+            if filename in DataFilenames.private_file.values():
+                private_file_list.append(filename)
+            elif filename in DataFilenames.public_file.values():
+                public_file_list.append(filename)
+            else:
+                SharedMethods.print_message(f"ERROR: File '{filename}' is not recognised as a valid database file. Please contact support using this error message...", "31")
+                return False
+    else: # default to updating all database files
+        for file in DataFilenames.private_file.values():
+            private_file_list.append(file)
+        for file in DataFilenames.public_file.values():
+            public_file_list.append(file)
+    
+    # copy the private data from the packaged data folder
+    distribution = importlib.resources.files(SharedVariables.package_name)
+    package_path = os.path.join(str(distribution), SharedVariables.private_data_name)
+
+    # Get the absolute path of the file in the package location
+    for file in private_file_list:
+        file_in_package = os.path.join(package_path, file)
+        target_file = os.path.join(controlled_data_path, file)
+        try:
+            shutil.copy(file_in_package, target_file)
+            SharedMethods.print_message(f"ATTENTION: '{file}' database updated to default dataset.","33")
+        except Exception as e:
+            SharedMethods.print_message(f"ERROR: Error copying file {file} to {target_file}: {e}. Please contact support using this error message...", "31")
+            return False
+    
+    # check online resources and download the public data to the same folder
+    # Check internet connection
+    if not InternetValidation.internet_check(SharedVariables.public_data_path):
+        SharedMethods.print_message(f"WARNING: Online databse updated cannot proceed due to not allowed network. Skipping...","33")
+        return False
+    
+    for file in public_file_list:
+        file_url = SharedVariables.raw_data_url_begin + file
+        # download the csv file to the target folder
+        target_file = os.path.join(controlled_data_path, file)
+        try:
+            response = requests.get(file_url)
+            response.raise_for_status()  # Raise an error for bad responses
+            with open(target_file, 'wb') as f:
+                f.write(response.content)
+            SharedMethods.print_message(f"ATTENTION: '{file}' database updated to default dataset.","33")
+        except Exception as e:
+            SharedMethods.print_message(f"ERROR: Error downloading file {file} from {file_url}: {e}. Please contact support using this error message...", "31")
+            return False
+        
+    return True
+
+# reset configuraiton file varile to default
+def reset_configuration_file_varible(key: str = "DEFAULT_ALL"):
+    """
+    This function reset configuration varible to default
+    return True of False
+    """
+    try:
+        if not os.path.exists(SharedVariables.config_file):
+            SharedMethods.print_message(f"ERROR: Configuration file not found. ","31")
+            return False
+
+        config_data = DataFilenames.default_config
+
+        if key == "DEFAULT_ALL": 
+            with open(SharedVariables.config_file, "w") as file:
+                json.dump(config_data, file, indent=4)
+            return True
+        else:
+            return set_configuration_file_variable(key,config_data[key]) 
+
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error resetting configuration: {e}","31")
+        return False
+
+
+# set configuration file
+def set_configuration_file_variable(key:str, value):
+    """
+    This function handle the configuration file value update
+    return True or False
+    """
+    try:
+        if not os.path.exists(CONFIG_FILE):
+            SharedMethods.print_message(f"ERROR: Configuration file not found. ","31")
+            return False
+        
+        with open(CONFIG_FILE, "r") as file:
+            config_data = json.load(file)
+        
+        if config_data.get(key) != value:
+            config_data[key] = value
+            with open(CONFIG_FILE, "w") as file:
+                json.dump(config_data, file, indent=4)
+        return True
+
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error setting configuration: {e}","31")
+        return False
+    
+# read configuration file varible
+def read_configuration_file_variable(key:str, update_required: bool = False):
+    """
+    This function read the configuration file and return value
+    return Value or False / None
+    """
+    try:
+        if not os.path.exists(CONFIG_FILE):
+            SharedMethods.print_message(f"ERROR: Configuration file not found. ","31")
+            return False
+
+        config_data = {}
+        with open(CONFIG_FILE, "r") as file:
+            config_data = json.load(file)
+        
+        if key not in config_data:
+            SharedMethods.print_message(f"WARNING: Configuration does not contain setting of {key}. ","33")
+            if update_required:
+                SharedMethods.print_message(f"WARNING: {key} will be set to default value. ","33")
+            return False
+        
+        return config_data[key]
+
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error reading configuration: {e}","31")
+        return False
+
+def version_updated():
+    try:
+        if os.path.exists(SharedVariables.config_file):
+            with open(SharedVariables.config_file, 'r') as file:
+                config_data = json.load(file)
+                if not config_data["package_version_number"] == SharedVariables.installed_version:
+                    return True
+        return False
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error reading configuration: {e}","31")
+        return False
+
+def update_elssa_core():
+    try:
+        # ensure the installation folder location exist
+        if os.path.exists(SharedVariables.package_path):
+            # validate if configuration path folder exist if not, create it
+            os.makedirs(SharedVariables.elssa_core_path, exist_ok=True)
+            # download the latest
+            if not AzureWorkflow.download_tdns_sharepoint_folder(AzureCloudID.DOC_LIBRARY,AzureCloudID.ELSSA_CORE_PATH,SharedVariables.elssa_core_path,True):
+                return False
+            return True
+
+        else:
+            SharedMethods.print_message(f"ERROR: {SharedVariables.package_name} has not been installed yet...","31")
+            return False
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error updating the PyELSSA core: {e}","31")
+        SharedMethods.print_message(f"ERROR: Please check the message above. Try again with proper internet or contact support...","31")
+        return False
+
+# processing of checking configuraiton file and set up approprite action
+def configuration_main():
+    # disable in debug mode (bypass the process in debug mode):
+    if SharedMethods.is_debug_mode():
+        return True
+
+    # validate if configuration path folder exist if not, create it
+    os.makedirs(SharedVariables.configuration_path, exist_ok=True)
+
+    # update default database if configuration file does not exist (1st run only)
+    if not os.path.exists(CONFIG_FILE):
+        # create empty configuration file.
+        try:
+            with open(CONFIG_FILE, "w") as file:
+                json.dump({}, file)
+        except Exception as e:
+            SharedMethods.print_message(f"ERROR: Error creating configuration: {e}","31")
+            return False
+    
+    # version update steps
+    try:
+        if version_updated():
+            # after the version udpate, elssa core is forced to be update, set to false
+            set_configuration_file_variable(key = 'elssa_core_updated',value = False)
+
+        # download the ELSSA core from the SharePoint
+        if not read_configuration_file_variable(key = 'elssa_core_updated'):
+            # trying the update the default library if success or not.
+            if not update_elssa_core():
+                # update not successful, force exit until update completed to ensure consistent version
+                return False
+            else:
+                # write the status to json configuraiton file
+                set_configuration_file_variable(key = 'elssa_core_updated',value = True)
+                SharedMethods.print_message(f"INFO: ELSSA Core Package Updating Succesfully. Consider relauch the application for proper reloading.","32")
+
+        if not read_configuration_file_variable(key = 'default_database_updated', update_required = True):
+            # trying the update the default library if success or not.
+            if not update_database_library():
+                # update not successful
+                database_library = False
+            else:
+                # update succesfully
+                database_library = True
+            # write the status to json configuraiton file
+            set_configuration_file_variable(key = 'default_database_updated',value = database_library)
+
+        set_configuration_file_variable(key = 'package_version_number', value = SharedVariables.installed_version)
+        return True
+
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error reading / writing configuration: {e}","31")
+        return False
+
+
+def main():
+    if not configuration_main():
+        SharedMethods.print_message(f"ERROR: Configuration environment is not set properly. Close and try it again...","31")
+        SharedMethods.print_message(f"ERROR: Contact support {SharedVariables.contacts} if the issue persist...","31")
+        return False
+    else:
+        # database folder check: This is on customised user database only
+        filenamelist = initial_missing_user_database_check()
+        if filenamelist:
+            update_database_library(filenamelist=filenamelist,library=1)
+        return True
+
+# Programme running
+if __name__ == '__main__':
+    main()

PyELSSA/gui/gui_base_frame.py

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+#=================================================================
+# Created by: Jieming Ye
+# Created on: Aug 2026
+# Last Modified: Aug 2026
+#=================================================================
+# Copyright (c) 2026 [Jieming Ye]
+#
+# This Python source code is licensed under the 
+# Open Source Non-Commercial License (OSNCL) v1.0
+# See LICENSE for details.
+#=================================================================
+"""
+This the base frame for this GUI
+"""
+#=================================================================
+# VERSION CONTROL
+# V1.0 (Jieming Ye) - Initial Version
+#
+#
+#=================================================================
+
+import os
+import tkinter as tk
+from tkinter import filedialog, ttk
+from threading import Thread
+from multiprocessing import Process
+from PyELSSA.shared_contents import SharedMethods, SharedVariables
+
+
+class BasePage(tk.Frame):
+    def __init__(self, parent, controller):
+        super().__init__(parent)
+        self.controller = controller
+        self.style = ttk.Style()
+        self._configure_styles()
+
+        self.headframe = self.create_frame(padding=(16, 16))
+        self.contentframe = self.create_frame(padding=(12, 8))
+        self.footerframe = self.create_frame(padding=(10, 6))
+
+    def _configure_styles(self):
+        self.style.configure('PageTitle.TLabel', font=('Helvetica', 16, 'bold'))
+        self.style.configure('PageSubtitle.TLabel', font=('Helvetica', 12, 'bold'))
+        self.style.configure('PageText.TLabel', font=('Helvetica', 10), foreground='#333333')
+        self.style.configure('Card.TLabelframe', borderwidth=1, relief='solid')
+        self.style.configure('Card.TLabelframe.Label', font=('Helvetica', 12, 'bold'))
+        self.style.configure('Action.TButton', font=('Helvetica', 10, 'bold'), padding=8)
+        self.style.configure('Secondary.TButton', font=('Helvetica', 10), padding=6)
+        self.style.configure('OptionText.TLabel', font=('Helvetica', 10), wraplength=660, foreground='#222222')
+        self.style.configure('Info.TLabel', font=('Helvetica', 9), foreground='#555555', wraplength=660)
+        self.style.configure('SmallText.TLabel', font=('Helvetica', 8), foreground='#444444', wraplength=660)
+
+    def create_frame(self, padding=(0, 0), row_weights=None, column_weights=None, **kwargs):
+        pack_options = {}
+        for option in ('fill', 'expand', 'side', 'anchor', 'padx', 'pady'):
+            if option in kwargs:
+                pack_options[option] = kwargs.pop(option)
+
+        frame = ttk.Frame(self, padding=padding, **kwargs)
+        if not pack_options:
+            pack_options = {'fill': tk.BOTH, 'expand': True}
+        frame.pack(**pack_options)
+
+        if row_weights is not None:
+            for index, weight in enumerate(row_weights):
+                frame.rowconfigure(index, weight=weight)
+        if column_weights is not None:
+            for index, weight in enumerate(column_weights):
+                frame.columnconfigure(index, weight=weight)
+
+        return frame
+
+    def create_section(self, parent, title=None, padding=(8, 6), pack=True, pack_options=None):
+        if title:
+            section = ttk.Labelframe(parent, text=title, style='Card.TLabelframe', padding=padding)
+        else:
+            section = ttk.Frame(parent, padding=padding)
+        if pack:
+            options = {'fill': tk.BOTH, 'expand': True, 'pady': (0, 8)}
+            if pack_options:
+                options.update(pack_options)
+            section.pack(**options)
+        return section
+
+    def create_scrollable_section(self, parent, title=None, height=280, padding=(8, 8)):
+        section = self.create_section(parent, title=title, padding=padding)
+        bg_color = '#f4f6f9'
+        try:
+            bg_color = section.cget('background')
+        except tk.TclError:
+            pass
+
+        canvas = tk.Canvas(section, borderwidth=0, highlightthickness=0, background=bg_color)
+        scrollbar = ttk.Scrollbar(section, orient='vertical', command=canvas.yview)
+        content = ttk.Frame(canvas)
+
+        canvas.configure(yscrollcommand=scrollbar.set)
+        scrollbar.pack(side='right', fill='y')
+        canvas.pack(side='left', fill='both', expand=True)
+        window_id = canvas.create_window((0, 0), window=content, anchor='nw')
+
+        def on_configure(event):
+            canvas.configure(scrollregion=canvas.bbox('all'))
+
+        def on_canvas_resize(event):
+            canvas.itemconfigure(window_id, width=event.width)
+
+        content.bind('<Configure>', on_configure)
+        canvas.bind('<Configure>', on_canvas_resize)
+
+        def on_mousewheel(event):
+            delta = -1 if event.delta > 0 else 1
+            canvas.yview_scroll(delta, 'units')
+
+        content.bind('<Enter>', lambda _: content.bind_all('<MouseWheel>', on_mousewheel))
+        content.bind('<Leave>', lambda _: content.unbind_all('<MouseWheel>'))
+        section.configure(height=height)
+        return content
+
+    def create_label(self, parent, text, style='PageText.TLabel', **kwargs):
+        label = ttk.Label(parent, text=text, style=style, **kwargs)
+        return label
+
+    def create_button(self, parent, text, command, style='Action.TButton', **kwargs):
+        button = ttk.Button(parent, text=text, command=command, style=style, **kwargs)
+        return button
+
+    def create_entry(self, parent, variable, width=32, **kwargs):
+        entry = ttk.Entry(parent, textvariable=variable, width=width, **kwargs)
+        return entry
+
+    def create_radio(self, parent, text, variable, value, **kwargs):
+        radio = ttk.Radiobutton(parent, text=text, variable=variable, value=value, **kwargs)
+        return radio
+
+    def auto_excel_select(self, variable):
+        initial_dir = os.getcwd()
+        file_path = filedialog.askopenfilename(title='Select File...', initialdir=initial_dir)
+        if not file_path:
+            return
+
+        variable.set(file_path)
+        selected_dir = os.path.dirname(file_path)
+        selected_dir = os.path.normpath(selected_dir)
+        if selected_dir != os.getcwd():
+            os.chdir(selected_dir)
+            SharedVariables.current_path = selected_dir
+            self.controller.working_directory.set(selected_dir)
+            SharedMethods.print_message(f'ATTENTION: Working directory set to: {selected_dir}','33')
+
+    def auto_file_select(self, variable):
+        initial_dir = os.getcwd()
+        file_path = filedialog.askopenfilename(title='Select File...', initialdir=initial_dir)
+        if not file_path:
+            return
+
+        variable.set(file_path)
+        selected_dir = os.path.dirname(file_path)
+        selected_dir = os.path.normpath(selected_dir)
+        if selected_dir != os.getcwd():
+            os.chdir(selected_dir)
+            SharedVariables.current_path = selected_dir
+            self.controller.working_directory.set(selected_dir)
+            SharedMethods.print_message(f'ATTENTION: Working directory set to: {selected_dir}','33')
+
+    def run_new_thread_or_process(self, target_script, **inputs):
+        try:
+            args = [
+                target_script,
+                None,
+                None,
+                None,
+                None,
+                None,
+                None,
+                None,
+                None,
+                None,
+                None,
+                SharedVariables.current_path,
+            ]
+
+            input_mapping = {
+                'text_input1': 1,
+                'text_input2': 2,
+                'option_input1': 3,
+                'option_input2': 4,
+                'time_input1': 5,
+                'time_input2': 6,
+                'add_text': 7,
+                'add_input1': 8,
+                'add_input2': 9,
+                'config_input': 10,
+            }
+
+            independent_process = False
+            for key, value in inputs.items():
+                if key in input_mapping:
+                    index = input_mapping[key]
+                    if isinstance(value, tk.Variable):
+                        args[index] = value.get()
+                    else:
+                        args[index] = value
+                elif key == 'independent_process':
+                    independent_process = bool(value)
+                else:
+                    SharedMethods.print_message(f'WARNING: Unrecognized input key "{key}" provided. Skipping...','33')
+
+            if independent_process:
+                process = Process(target=SharedMethods.launch_new_thread_or_process, args=tuple(args))
+                process.start()
+            else:
+                thread = Thread(target=SharedMethods.launch_new_thread_or_process, args=tuple(args))
+                thread.start()
+
+        except Exception as e:
+            SharedMethods.print_message(
+                f'ERROR: Error in threading/processing...{e}. Contact Support / Do not carry out multiple tasking at the same time.',
+                '31'
+            )