atomicshop 2.12.19__py3-none-any.whl → 2.12.20__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.12.19'
+__version__ = '2.12.20'

atomicshop/startup/win/startup_folder.py

@@ -0,0 +1,53 @@
+import os
+from pathlib import Path
+
+from ...wrappers.pywin32w import winshell
+
+
+STARTUP_FOLDER = os.path.join(os.environ['APPDATA'], 'Microsoft', 'Windows', 'Start Menu', 'Programs', 'Startup')
+
+
+def add_to_startup_folder_with_shortcut(exe_file_path: str, shortcut_name: str) -> str:
+    """
+    This function will create a shortcut in the startup folder to your executable.
+
+    :param exe_file_path: The path to your executable file.
+    :param shortcut_name: The name of the shortcut file to create in the startup folder.
+        No need to add the ".lnk" extension.
+    :return: The path to the shortcut file created.
+    """
+
+    # Get the startup folder path and create if non-existent.
+    Path(STARTUP_FOLDER).mkdir(parents=True, exist_ok=True)
+
+    shortcut_file_path = str(Path(STARTUP_FOLDER, f'{shortcut_name}.lnk'))
+
+    # Create a shortcut to the executable file.
+    winshell.create_shortcut(exe_file_path, shortcut_file_path)
+
+    return shortcut_file_path
+
+
+def is_in_startup_folder(shortcut_name: str):
+    """
+    This function will check if the shortcut is in the startup folder.
+
+    :param shortcut_name: The name of the shortcut file to check in the startup folder.
+        No need to add the ".LNK" extension.
+    :return: True if the shortcut is in the startup folder, False otherwise.
+    """
+    return Path(STARTUP_FOLDER, f'{shortcut_name}.lnk').exists()
+
+
+def remove_from_startup_folder(shortcut_name: str):
+    """
+    This function will remove the shortcut from the startup folder.
+
+    :param shortcut_name: The name of the shortcut file to remove from the startup folder.
+        No need to add the ".LNK" extension.
+    """
+    shortcut_file_path = Path(STARTUP_FOLDER, f'{shortcut_name}.lnk')
+    if shortcut_file_path.exists():
+        shortcut_file_path.unlink()
+        return True
+    return False

atomicshop/startup/win/task_scheduler.py

@@ -0,0 +1,119 @@
+import os
+import datetime
+
+import win32com.client
+import pythoncom
+
+
+TRIGGER_ONE_TIME: int = 1
+TRIGGER_DAILY: int = 2
+TRIGGER_AT_SYSTEM_STARTUP: int = 8
+TRIGGER_ON_LOGON: int = 9
+
+
+def create_on_logon_task_with_system_privileges(exe_file_path: str, task_name: str, user_id: str = None):
+    """
+    This function will add a task to the Windows Task Scheduler with system privileges.
+
+    :param exe_file_path: The path to your executable file.
+    :param task_name: The name of the task to create in the Task Scheduler.
+    :param user_id: The user ID to run the task as.
+        None: the task will run for every user that logs on.
+        "SYSTEM": is a common user ID to run tasks with system privileges.
+    :return: True if the task was added successfully, False otherwise.
+    """
+
+    scheduler = win32com.client.Dispatch('Schedule.Service')
+    scheduler.Connect()
+
+    root_folder = scheduler.GetFolder('\\')
+    task_def = scheduler.NewTask(0)
+
+    # Set up registration information for the task
+    reg_info = task_def.RegistrationInfo
+    reg_info.Description = f'Task to run {os.path.basename(exe_file_path)} at logon'
+    reg_info.Author = 'Your Name'
+
+    # Set up the principal for the task
+    principal = task_def.Principal
+    if user_id is not None:
+        principal.UserId = user_id
+    # principal.LogonType = 3  # TaskLogonTypeInteractiveToken, Only run when the user is logged on.
+    principal.LogonType = 1  # 1 is for password not required
+    principal.RunLevel = 1  # TaskRunLevelHighest
+
+    # Create the logon trigger
+    trigger = task_def.Triggers.Create(TRIGGER_ON_LOGON)
+    if user_id:
+        trigger.UserId = user_id
+    trigger.Id = "LogonTriggerId"
+    trigger.Enabled = True
+    trigger.StartBoundary = datetime.datetime.now().isoformat()  # Set start boundary to current time in ISO format
+
+    # Create the action to run the executable
+    action = task_def.Actions.Create(0)  # 0 stands for TASK_ACTION_EXEC
+    action.Path = exe_file_path
+    action.WorkingDirectory = os.path.dirname(exe_file_path)
+    action.Arguments = ''
+
+    # Set task settings
+    settings = task_def.Settings
+    settings.Enabled = True
+    settings.StartWhenAvailable = True
+    settings.Hidden = False
+    settings.StopIfGoingOnBatteries = False
+    settings.DisallowStartIfOnBatteries = False
+    # Sets the limit to zero, which means the task will run indefinitely. The default is 3 days.
+    settings.ExecutionTimeLimit = 'PT0S'
+
+    # Register the task
+    root_folder.RegisterTaskDefinition(
+        task_name, task_def, 6,  # 6 is for CREATE_OR_UPDATE
+        None,  # No user (runs in system context)
+        None,  # No password
+        3
+    )
+
+
+def is_task_in_scheduler(task_name: str, scheduler_instance=None) -> bool:
+    """
+    This function will check if the task is in the Windows Task Scheduler.
+
+    :param task_name: The name of the task to check in the Task Scheduler.
+    :param scheduler_instance: The instance of the Task Scheduler to use.
+        If None, a new instance will be created.
+    :return: True if the task is in the Task Scheduler, False otherwise.
+    """
+
+    if scheduler_instance is None:
+        scheduler_instance = win32com.client.Dispatch('Schedule.Service')
+        scheduler_instance.Connect()
+
+    try:
+        root_folder = scheduler_instance.GetFolder('\\')
+        root_folder.GetTask(task_name)
+        return True
+    except pythoncom.com_error as e:
+        if e.hresult == -2147352567 and e.excepinfo[5] == -2147024894:  # HRESULT code for "Task does not exist"
+            return False
+        else:
+            raise
+
+
+def remove_task_from_scheduler(task_name: str) -> bool:
+    """
+    This function will remove the task from the Windows Task Scheduler.
+
+    :param task_name: The name of the task to remove from the Task Scheduler.
+    :return: True if the task was removed successfully, False otherwise.
+    """
+
+    scheduler_instance = win32com.client.Dispatch('Schedule.Service')
+    scheduler_instance.Connect()
+
+    if not is_task_in_scheduler(task_name, scheduler_instance=scheduler_instance):
+        return False
+    else:
+        root_folder = scheduler_instance.GetFolder('\\')
+        root_folder.GetTask(task_name)
+        return True

atomicshop/wrappers/loggingw/loggingw.py

@@ -67,12 +67,90 @@ def get_logger_with_timedfilehandler(
 
 def get_logger_with_stream_handler_and_timedfilehandler(
         logger_name: str,
-        directory_path, file_name: str = None, file_extension: str = '.txt',
-        logging_level="DEBUG", formatter_filehandler='default',
+        directory_path,
+        file_name: str = None,
+        file_extension: str = '.txt',
+        logging_level="DEBUG",
+        formatter_filehandler='default',
         formatter_streamhandler: str = "%(levelname)s | %(threadName)s | %(name)s | %(message)s",
-        formatter_message_only: bool = False, disable_duplicate_ms: bool = False,
-        when: str = "midnight", interval: int = 1, delay: bool = True, encoding=None
+        formatter_message_only: bool = False,
+        disable_duplicate_ms: bool = False,
+        when: str = "midnight",
+        interval: int = 1,
+        delay: bool = True,
+        encoding=None
 ) -> logging.Logger:
+    """
+    Function to get a logger and add StreamHandler and TimedRotatingFileHandler to it.
+
+    :param logger_name: Name of the logger.
+    :param directory_path: string, Path to the directory where the log file will be created.
+    :param file_name: string, Name of the log file without file extension, since we add it through separate argument.
+        If not provided, logger name will be used.
+    :param file_extension: string, Extension of the log file. Default is '.txt'.
+        '.txt': Text file.
+        '.csv': CSV file.
+        '.json': JSON file.
+    :param logging_level: str or int, Logging level for the handler, that will use the logger while initiated.
+    :param formatter_filehandler: string, Formatter to use for handler. It is template of how a message will look like.
+        None: No formatter will be used.
+        'default': Default formatter will be used for each file extension:
+            .txt: "%(asctime)s | %(levelname)s | %(threadName)s | %(name)s | %(message)s"
+            .csv: "%(asctime)s,%(levelname)s,%(threadName)s,%(name)s,%(message)s"
+            .json: '{"time": "%(asctime)s", "level": "%(levelname)s", "thread": "%(threadName)s",
+                "logger": "%(name)s", "message": "%(message)s"}'
+    :param formatter_streamhandler: string, Formatter to use for StreamHandler. It is template of how a message will
+        look like.
+    :param formatter_message_only: bool, If set to True, formatter will be used only for the 'message' part.
+    :param disable_duplicate_ms: bool, If set to True, duplicate milliseconds will be removed from formatter
+        'asctime' element.
+    :param when: string, When to rotate the log file. Default is 'midnight'.
+        [when="midnight"] is set to rotate the filename at midnight. This means that the current file name will be
+        added Yesterday's date to the end of the file and today's file will continue to write at the same
+        filename. Also, if the script finished working on 25.11.2021, the name of the log file will be "test.log"
+        If you run the script again on 28.11.2021, the logging module will take the last modification date of
+        the file "test.log" and assign a date to it: test.log.2021_11_25
+        The log filename of 28.11.2021 will be called "test.log" again.
+    :param interval: int, Interval to rotate the log file. Default is 1.
+        If 'when="midnight"' and 'interval=1', then the log file will be rotated every midnight.
+        If 'when="midnight"' and 'interval=2', then the log file will be rotated every 2nd midnights.
+    :param delay: bool, If set to True, the log file will be created only if there's something to write.
+    :param encoding: string, Encoding to use for the log file. Default is None.
+
+    :return: Logger.
+
+    ================================================================================================================
+
+    Working example to write CSV logs to the file and output messages to the console:
+    from atomicshop.wrappers.loggingw import loggingw
+
+
+    def main():
+        def output_csv_header():
+            # Since there is no implementation of header in logging file handler modules, we'll do it manually each time.
+            header: list = ['time',
+                           'host',
+                           'path',
+                           'error'
+                           ]
+            error_logger.info(','.join(header))
+
+
+        output_directory: str = "D:\\logs"
+
+        error_logger = loggingw.get_logger_with_stream_handler_and_timedfilehandler(
+            logger_name="errors", directory_path=output_directory,
+            file_extension=".csv", formatter_message_only=True
+        )
+
+        output_csv_header()
+
+        error_logger.info(f"{datetime.now()},host1,/path/to/file,error message")
+
+
+    if __name__ == "__main__":
+        main()
+    """
     logger = get_logger_with_level(logger_name, logging_level)
     add_stream_handler(logger, logging_level, formatter_streamhandler, formatter_message_only)
     add_timedfilehandler_with_queuehandler(

atomicshop/wrappers/pywin32w/winshell.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+from win32com.client import Dispatch
+
+
+def create_shortcut(file_path_to_link: str, shortcut_file_path: str):
+    """
+    Create a shortcut in the startup folder to the specified file.
+
+    :param file_path_to_link: The path to the file you want to create a shortcut to.
+    :param shortcut_file_path: The name of the shortcut file. Should be with the ".lnk" extension.
+    """
+
+    shell = Dispatch('WScript.Shell')
+    shortcut = shell.CreateShortCut(shortcut_file_path)
+    shortcut.Targetpath = file_path_to_link
+    shortcut.WorkingDirectory = str(Path(file_path_to_link).parent)
+    shortcut.Description = f"Shortcut for {Path(file_path_to_link).name}"
+    shortcut.save()

{atomicshop-2.12.19.dist-info → atomicshop-2.12.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.12.19
+Version: 2.12.20
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.12.19.dist-info → atomicshop-2.12.20.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=CBepG0XgfpgafeV__swI0Jz0kUF1uJvK3WLlJWWcQwk,124
+atomicshop/__init__.py,sha256=U5HBBCgZbCFjvJTS1UanW_wKk5yZesdp5sAnQ2RGDSg,124
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -142,6 +142,10 @@ atomicshop/monitor/checks/process_running.py,sha256=x66wd6-l466r8sbRQaIli0yswyGt
 atomicshop/monitor/checks/url.py,sha256=1PvKt_d7wFg7rDMFpUejAQhj0mqWsmlmrNfjNAV2G4g,4123
 atomicshop/ssh_scripts/process_from_ipv4.py,sha256=uDBKZ2Ds20614JW1xMLr4IPB-z1LzIwy6QH5-SJ4j0s,1681
 atomicshop/ssh_scripts/process_from_port.py,sha256=uDTkVh4zc3HOTTGv1Et3IxM3PonDJCPuFRL6rnZDQZ4,1389
+atomicshop/startup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atomicshop/startup/win/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atomicshop/startup/win/startup_folder.py,sha256=2RZEyF-Mf8eWPlt_-OaoGKKnMs6YhELEzJZ376EI0E0,1891
+atomicshop/startup/win/task_scheduler.py,sha256=qALe-8sfthYxsdCViH2r8OsH3x-WauDqteg5RzElPdk,4348
 atomicshop/wrappers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/_process_wrapper_curl.py,sha256=XkZZXYl7D0Q6UfdWqy-18AvpU0yVp9i2BVD2qRcXlkk,841
 atomicshop/wrappers/_process_wrapper_tar.py,sha256=WUMZFKNrlG4nJP9tWZ51W7BR1j_pIjsjgyAStmWjRGs,655
@@ -214,7 +218,7 @@ atomicshop/wrappers/loggingw/checks.py,sha256=AGFsTsLxHQd1yAraa5popqLaGO9VM0KpcP
 atomicshop/wrappers/loggingw/formatters.py,sha256=mUtcJJfmhLNrwUVYShXTmdu40dBaJu4TS8FiuTXI7ys,7189
 atomicshop/wrappers/loggingw/handlers.py,sha256=qm5Fbu8eDmlstMduUe5nKUlJU5IazFkSnQizz8Qt2os,5479
 atomicshop/wrappers/loggingw/loggers.py,sha256=DHOOTAtqkwn1xgvLHSkOiBm6yFGNuQy1kvbhG-TDog8,2374
-atomicshop/wrappers/loggingw/loggingw.py,sha256=v9WAseZXB50LluT9rIUcRvvevg2nLVKPgz3dbGejfV0,12151
+atomicshop/wrappers/loggingw/loggingw.py,sha256=TJBT8n9wCcAgrnjvT3sz3OvRqJ0A3Q5GtYt7ZncvVv4,16146
 atomicshop/wrappers/loggingw/reading.py,sha256=CtYOwOLFHj_hqYyZx-dKUo5ZDrn3cO-f7vU4EX515xI,14980
 atomicshop/wrappers/nodejsw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/nodejsw/install_nodejs.py,sha256=QZg-R2iTQt7kFb8wNtnTmwraSGwvUs34JIasdbNa7ZU,5154
@@ -233,6 +237,7 @@ atomicshop/wrappers/psutilw/disks.py,sha256=3ZSVoommKH1TWo37j_83frB-NqXF4Nf5q5mB
 atomicshop/wrappers/psutilw/memories.py,sha256=_S0aL8iaoIHebd1vOFrY_T9aROM5Jx2D5CvDh_4j0Vc,528
 atomicshop/wrappers/psutilw/psutilw.py,sha256=G22ZQfGnqX15-feD8KUXfEZO4pFkIEnB8zgPzJ2jc7M,20868
 atomicshop/wrappers/psycopgw/psycopgw.py,sha256=XJvVf0oAUjCHkrYfKeFuGCpfn0Oxj3u4SbKMKA1508E,7118
+atomicshop/wrappers/pywin32w/winshell.py,sha256=i2bKiMldPU7_azsD5xGQDdMwjaM7suKJd3k0Szmcs6c,723
 atomicshop/wrappers/pywin32w/wmi_win32process.py,sha256=qMzXtJ5hBZ5ydAyqpDbSx0nO2RJQL95HdmV5SzNKMhk,6826
 atomicshop/wrappers/socketw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/socketw/accepter.py,sha256=HQC1EyZmyUtVEfFbaBkHCE-VZp6RWyd9mEqAkgsE1fk,1749
@@ -250,8 +255,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=AhpurHJmP2kgzHaUbq5ey
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.12.19.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.12.19.dist-info/METADATA,sha256=XjMOMxBIk9wbHMRy4KgeBeYKoy8sD8FJjt-CGllbCsw,10479
-atomicshop-2.12.19.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.12.19.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.12.19.dist-info/RECORD,,
+atomicshop-2.12.20.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.12.20.dist-info/METADATA,sha256=tpZ7mC5c8cpsmgMGGFRrXl5NUsNi8yfGpcMhH8HEYFY,10479
+atomicshop-2.12.20.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.12.20.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.12.20.dist-info/RECORD,,