msb-rpa 0.1.0__tar.gz

msb_rpa-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 lfrmipypi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

msb_rpa-0.1.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: msb_rpa
+Version: 0.1.0
+Summary: Login metoder og diverse hjælper funktioner til RPA projekter
+Author-email: Michael Fredslund Larsen <lfrmi@aarhus.dk>
+License: MIT License
+        
+        Copyright (c) 2024 lfrmipypi
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyodbc==5.0.1
+Requires-Dist: selenium==4.14.0
+Requires-Dist: pyperclip==1.8.2
+Requires-Dist: pyautogui==0.9.54
+Requires-Dist: pywinauto==0.6.8
+Requires-Dist: requests==2.31.0
+
+# Introduction
+This is a collection of functions generally used in RPA projects in AAK MSB.
+
+# Getting Started
+Use pip install aak_msb_generelt and import any function relevant in the current file.

msb_rpa-0.1.0/README.md

@@ -0,0 +1,5 @@
+# Introduction
+This is a collection of functions generally used in RPA projects in AAK MSB.
+
+# Getting Started
+Use pip install aak_msb_generelt and import any function relevant in the current file.

msb_rpa-0.1.0/msb_rpa/dato_og_tid.py

@@ -0,0 +1,64 @@
+"""
+Module for handling date and time related operations.
+"""
+
+
+def month_conversion(month_name):
+    """
+    Converts a Danish month name to its corresponding numeric value.
+
+    Args:
+        month_name (str): The name of the month in Danish (e.g., 'januar', 'februar').
+
+    Returns:
+        int: The numeric value of the month (1-12).
+
+    Raises:
+        ValueError: If the month name is not valid.
+    """
+    months = {
+        'januar': 1, 'februar': 2, 'marts': 3, 'april': 4, 'maj': 5, 'juni': 6,
+        'juli': 7, 'august': 8, 'september': 9, 'oktober': 10, 'november': 11, 'december': 12
+    }
+
+    month_name = month_name.lower().strip()
+
+    if month_name not in months:
+        raise ValueError(f"Invalid month name: {month_name}")
+
+    return months[month_name]
+
+
+def get_last_day_of_month(year, month):
+    """
+    Finds the last day of a given month for a given year.
+
+    Args:
+        year (int): The year (e.g., 2024).
+        month (int): The numeric month (1-12).
+
+    Returns:
+        int: The last day of the month (28-31).
+
+    Raises:
+        ValueError: If the month is out of range (not between 1 and 12).
+    """
+    if not 1 <= month <= 12:
+        raise ValueError(f"Invalid month: {month}. Month must be between 1 and 12.")
+
+    num_days_in_month = [31, 29 if _is_leap_year(year) else 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+
+    return num_days_in_month[month - 1]
+
+
+def _is_leap_year(year):
+    """
+    Determines if a given year is a leap year.
+
+    Args:
+        year (int): The year to check.
+
+    Returns:
+        bool: True if the year is a leap year, False otherwise.
+    """
+    return year % 4 == 0 and (year % 100 != 0 or year % 400 == 0)

msb_rpa-0.1.0/msb_rpa/generelt.py

@@ -0,0 +1,95 @@
+"""
+Module for inserting data into ResultTable
+"""
+import time
+import socket
+import pyodbc
+from msb_rpa.web import close_website_panes
+from msb_rpa.web import get_driver()
+
+
+def sql_insert_result(rpa_id: str,
+                      executionid: str,
+                      resulttype: str,
+                      resultinjson: str,
+                      conn_str: str,
+                      resulttable: str):
+    """
+    Inserts a row into the given result table using the provided connection.
+
+    Args:
+        rpa_id (str): GUID for the RPA process.
+        executionid (str): GUID for the execution.
+        resulttype (str): Indicates the type of result.
+        resultinjson (str): Result in JSON format.
+        conn_str (str): Connection string for the database.
+        resulttable (str): Table name in the format [schema].[table].
+
+    Note:
+        - `rpa_id` and `executionid` should be GUIDs in string format (e.g., str(uuid.uuid4())).
+        - If `resulttype` is '1', `resultinjson` is converted to: {"Maskine":"<hostname>"}.
+    """
+
+    # Convert result to default format if resulttype is '1'
+    if resulttype == '1':
+        resultinjson = f'{{"Maskine":"{socket.gethostname()}"}}'
+
+    # Construct the SQL statement
+    sql_statement = f'''
+    INSERT INTO {resulttable} (RPA_ID, ExecutionID, ResultType, ResultInJson)
+    VALUES (?, ?, ?, ?)
+    '''
+
+    # Debugging output
+    print("SQL Statement:", sql_statement)
+    print("Values:", (rpa_id, executionid, resulttype, resultinjson))
+
+    # Execute the insert operation
+    with pyodbc.connect(conn_str) as connection:
+        with connection.cursor() as cursor:
+            cursor.execute(sql_statement, (rpa_id, executionid, resulttype, resultinjson))
+            connection.commit()
+
+
+def use_retry_logic(func, *args, max_retries: int = 3, sleep_time: int = 2, target=None, **kwargs):
+    """
+    Applies retry logic to a function.
+
+    Args:
+        func (callable): The function to retry.
+        *args: Positional arguments to pass to the function.
+        max_retries (int): Maximum number of retries (0-5). Default is 3.
+        sleep_time (int): Time to sleep between retries in seconds. Default is 2.
+        target (str, optional): The target to match against window title or URL for closing specific windows.
+                                If None, all windows will be closed.
+        **kwargs: Keyword arguments to pass to the function.
+    """
+
+    driver = get_driver()
+
+    class BusinessError(Exception):
+        """An empty exception used to identify errors caused by breaking business rules"""
+
+    if not (0 <= max_retries <= 5):
+        raise ValueError("max_retries must be between 0 and 5")
+
+    last_exception = None
+    for attempt in range(max_retries + 1):
+        try:
+            return func(*args, **kwargs)
+        except BusinessError as e:
+            print(f"Business error occurred: {e}")
+            # Do not retry for business errors
+            raise BusinessError(e) from e
+        except Exception as e:
+            print(f"Process failed on attempt {attempt + 1}: {e}")
+            last_exception = e
+
+        if attempt < max_retries:
+            print("Retrying...")
+            close_website_panes(driver, target=target)
+            time.sleep(sleep_time)
+        else:
+            print("All retries failed.")
+            close_website_panes(driver, target=target)
+            raise Exception(f"Failed after {max_retries} retries: {last_exception}")

msb_rpa-0.1.0/msb_rpa/logins.py

@@ -0,0 +1,163 @@
+"""
+Login Module
+
+This module contains functions for logging into various systems and applications,
+including Fasit, KMD BogV, and Opus.
+
+Dependencies:
+- Selenium
+- Pywinauto
+- Pyautogui
+"""
+import os
+import time
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+from pywinauto import Application, findwindows
+import pyautogui
+from msb_rpa.web import get_driver
+
+# Constants
+WINDOWS_USERNAME = os.getenv('USERNAME')
+DOWNLOAD_DIRECTORY = f"C:\\Users\\{WINDOWS_USERNAME}\\Downloads"
+
+
+def fasit_login(username: str, password: str, timers=None) -> bool:
+    """
+    Logger ind i Fasit (https://login.fasit.dk/aarhus/aak) ved at indtaste brugernavn og password
+
+    Args:
+        username (str): Fasit username.
+        password (str): Fasit password.
+        timers (str): Pass in timers extracted from OpenOrchestrator. If not default value is: timers = {"sleep_time": 2, "long_sleep_time": 5, "wait_time": 15, "long_wait_time": 30}
+
+    Returns:
+        bool: True if the login was succesful, else False.
+    """
+    if timers is None:
+        timers = {"sleep_time": 2, "long_sleep_time": 5, "wait_time": 15, "long_wait_time": 30}
+
+    try:
+        url = "https://login.fasit.dk/aarhus/aak"
+        driver = get_driver()
+        driver.get(url)
+        driver.maximize_window()
+        wait = WebDriverWait(driver, timers["wait_time"])
+
+        # BRUGERNAVN INDTASTES.
+        element = wait.until(EC.visibility_of_element_located((By.NAME, "loginfmt")))
+        element.send_keys(username)
+        time.sleep(timers["sleep_time"])
+
+        element = wait.until(EC.element_to_be_clickable((By.CSS_SELECTOR, "input[type='submit']")))
+        element.click()
+        time.sleep(timers["sleep_time"])
+
+        # PASSWORD INDTASTES.
+        element = wait.until(EC.visibility_of_element_located((By.NAME, "passwd")))
+        element.send_keys(password)
+
+        element = wait.until(EC.element_to_be_clickable((By.CSS_SELECTOR, "input[type='submit']")))
+        element.click()
+
+        search = wait.until(EC.presence_of_element_located((By.XPATH, '//div[@class="layout__app-header"]//div[@class="MuiBox-root css-0"]')))
+        logged_in_tekst = search.text
+        print(logged_in_tekst)
+
+        return True
+
+    except Exception:
+        return False
+
+
+def bogv_login(username, password):
+    """
+    Logger ind i KMD BogV windows applikationen.
+
+    Parameters:
+        username (str): The username for login.
+        password (str): The password for login.
+
+    Requirements:
+        - KMD BogV must be installed at the default path.
+        - Requires `pywinauto` and `pyautogui` libraries.
+
+    """
+    program_path = r'C:\Program Files (x86)\KMD\BogV\BogV.exe'
+    app = Application(backend='uia').start(program_path, timeout=10)
+    app = Application(backend="uia").connect(title="Tilslutning til KMD", class_name="ThunderRT6FormDC")
+
+    kmd_bogv = app.window(title="Tilslutning til KMD", class_name="ThunderRT6FormDC")
+    kmd_bogv.set_focus()
+
+    brugernavn = kmd_bogv.child_window(auto_id='7')
+    brugernavn.click_input()
+    pyautogui.typewrite(username, interval=0.1)
+
+    passwordfelt = kmd_bogv.child_window(auto_id='6')
+    passwordfelt.click_input()
+    pyautogui.typewrite(password, interval=0.1)
+
+    loginknap = kmd_bogv.child_window(title="Logon", auto_id="4", control_type="Button")
+    loginknap.click_input()
+
+
+# Opus Login
+def opus_login(username: str, password: str):
+    """
+    Logs into the Opus system via the web and performs additional steps.
+
+    Parameters:
+        username (str): The username for login.
+        password (str): The password for login.
+    """
+    driver = get_driver()
+
+    wait = WebDriverWait(driver, 10)
+    url = "https://portal.kmd.dk/irj/portal"
+
+    driver.get(url)
+    driver.maximize_window()
+
+    element = wait.until(EC.visibility_of_element_located((By.ID, "logonuidfield")))
+    element.send_keys(username)
+
+    element = wait.until(EC.visibility_of_element_located((By.ID, "logonpassfield")))
+    element.send_keys(password)
+
+    element = wait.until(EC.element_to_be_clickable((By.ID, "buttonLogon")))
+    element.click()
+
+    xpath_expression = '//div[@displayname="Mine Genveje" and starts-with(@id, "tabIndex")]'
+    element = wait.until(EC.element_to_be_clickable((By.XPATH, xpath_expression)))
+    element.click()
+
+    time.sleep(5)
+    files = os.listdir(DOWNLOAD_DIRECTORY)
+    for file in files:
+        if file.endswith("tx.sap"):
+            os.system(f"start {DOWNLOAD_DIRECTORY}\\{file}")
+            break
+
+    _opus_aabn()
+    driver.quit()
+
+
+def _opus_aabn():
+    """
+    Handles opening and interacting with the SAP window after Opus login.
+    """
+    sap_window_title = "Information"
+    time.sleep(10)
+    sap_window_handle = findwindows.find_window(title=sap_window_title)
+    sap_window_gw = Application(backend="uia").connect(handle=sap_window_handle)
+    sap_app_window = sap_window_gw.window(title=sap_window_title, handle=sap_window_handle)
+    sap_app_window.set_focus()
+
+    app_toolbar = sap_app_window.child_window(title="AppToolbar")
+    if app_toolbar:
+        fortset_button = app_toolbar.child_window(title="Fortsæt")
+        fortset_button.wait("enabled", timeout=10)
+        if fortset_button:
+            fortset_button.click_input()

msb_rpa-0.1.0/msb_rpa/web.py

@@ -0,0 +1,72 @@
+"""
+Module for managing browser tabs and WebDriver operations using Selenium.
+"""
+import re
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+
+driver = None
+
+
+def get_driver():
+    """Global webdriver"""
+    global driver
+    if driver is None:
+        chrome_options = Options()
+        chrome_options.add_argument("--disable-search-engine-choice-screen")
+        driver = webdriver.Chrome(options=chrome_options)
+    return driver
+
+
+def pick_website_pane(driver: webdriver, target: str) -> bool:
+    """
+    Switches to the browser tab that matches the target URL or title of the pane.
+
+    Args:
+        driver (webdriver): The Selenium WebDriver instance.
+        target (str): The target URL/title to find in open browser tabs.
+
+    Returns:
+        bool: True if a tab with the target URL/title is found and switched to, False otherwise.
+    """
+    window_handles = driver.window_handles
+
+    for handle in window_handles:
+        driver.switch_to.window(handle)
+        if isinstance(target, str):
+            if target.lower() in driver.title.lower():
+                return True  # Successfully switched to the new window
+        else:
+            if target in driver.current_url:
+                return True  # Successfully switched to the new window
+
+    return False  # No window with the target URL or title found
+
+
+def close_website_panes(driver: webdriver, target=None):
+    """
+    Closes browser windows based on the provided target, or all windows if no target is specified.
+    Searches for the target in both window titles and URLs.
+
+    Args:
+        driver (webdriver): The Selenium WebDriver instance.
+        target (str, optional): The target to match against window title or URL.
+                                If None, all windows will be closed.
+    """
+    handles_to_close = []
+
+    for handle in driver.window_handles:
+        driver.switch_to.window(handle)
+        if target is None or (target and (re.search(target, driver.title) or re.search(target, driver.current_url))):
+            print(f"Marking for closure: Title '{driver.title}', URL '{driver.current_url}'")
+            handles_to_close.append(handle)
+
+    for handle in handles_to_close:
+        driver.switch_to.window(handle)
+        driver.close()
+
+    if driver.window_handles:
+        driver.switch_to.window(driver.window_handles[0])
+    else:
+        print("All windows closed.")
+        driver = None

msb_rpa-0.1.0/msb_rpa.egg-info/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: msb_rpa
+Version: 0.1.0
+Summary: Login metoder og diverse hjælper funktioner til RPA projekter
+Author-email: Michael Fredslund Larsen <lfrmi@aarhus.dk>
+License: MIT License
+        
+        Copyright (c) 2024 lfrmipypi
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyodbc==5.0.1
+Requires-Dist: selenium==4.14.0
+Requires-Dist: pyperclip==1.8.2
+Requires-Dist: pyautogui==0.9.54
+Requires-Dist: pywinauto==0.6.8
+Requires-Dist: requests==2.31.0
+
+# Introduction
+This is a collection of functions generally used in RPA projects in AAK MSB.
+
+# Getting Started
+Use pip install aak_msb_generelt and import any function relevant in the current file.

msb_rpa-0.1.0/msb_rpa.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+msb_rpa/__init__.py
+msb_rpa/dato_og_tid.py
+msb_rpa/generelt.py
+msb_rpa/logins.py
+msb_rpa/web.py
+msb_rpa.egg-info/PKG-INFO
+msb_rpa.egg-info/SOURCES.txt
+msb_rpa.egg-info/dependency_links.txt
+msb_rpa.egg-info/requires.txt
+msb_rpa.egg-info/top_level.txt
+tests/__init__.py

msb_rpa-0.1.0/msb_rpa.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

msb_rpa-0.1.0/msb_rpa.egg-info/requires.txt

@@ -0,0 +1,6 @@
+pyodbc==5.0.1
+selenium==4.14.0
+pyperclip==1.8.2
+pyautogui==0.9.54
+pywinauto==0.6.8
+requests==2.31.0

msb_rpa-0.1.0/msb_rpa.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+dist
+msb_rpa
+tests

msb_rpa-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "msb_rpa"
+version = "0.1.0"
+description = "Login metoder og diverse hjælper funktioner til RPA projekter"
+authors = [{name = "Michael Fredslund Larsen", email = "lfrmi@aarhus.dk"}]
+license = {file = "LICENSE"}
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "pyodbc == 5.0.1",
+    "selenium == 4.14.0",
+    "pyperclip  == 1.8.2",
+    "pyautogui == 0.9.54",
+    "pywinauto == 0.6.8",
+    "requests == 2.31.0"
+]
+
+[tool.setuptools.packages.find]
+where = ["."]

msb_rpa-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+