process-automation 1.0.1__tar.gz

process_automation-1.0.1/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Mircea Sava Ioan. All rights reserved.
+
+This software is proprietary. No part of this software may be reproduced,
+distributed, modified, or used in any form without prior written permission
+from the copyright holder.
+
+For licensing inquiries, contact the copyright holder.

process_automation-1.0.1/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: process-automation
+Version: 1.0.1
+Summary: Automate SAP data extraction, SharePoint upload, and Excel macro execution
+Author: Mircea Sava Ioan
+License: Copyright (c) 2026 Mircea Sava Ioan. All rights reserved.
+        
+        This software is proprietary. No part of this software may be reproduced,
+        distributed, modified, or used in any form without prior written permission
+        from the copyright holder.
+        
+        For licensing inquiries, contact the copyright holder.
+        
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: xlwings
+Requires-Dist: pywin32
+Requires-Dist: psutil
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# SAP Automation
+
+## What is this?
+
+We regularly need to pull data from SAP, format it as Excel, and upload it to SharePoint. Doing this manually is slow and repetitive. These scripts automate the entire process so you can run a single Python file and have the data extracted, saved, and uploaded automatically.
+
+## Who is this for?
+
+Anyone who needs to extract SAP reports on a recurring basis. You do not need to be a programmer. The templates are designed so you only need to:
+
+1. Record your SAP steps (SAP has a built-in script recorder)
+2. Paste the recording into the template
+3. Fill in a few settings (transaction code, file paths)
+4. Run the script
+
+## How it works
+
+The scripts follow this workflow:
+
+1. Open SAP and connect to PR1
+2. Run your recorded SAP transaction (fill in fields, execute report, click export)
+3. Save the exported file locally
+4. Read the file into memory
+5. Copy a checked-in Excel template from SharePoint, write the data into it, and save it back to SharePoint
+6. Clean up temporary files
+
+The "checked-in file" is an `.xlsx` template that lives in a SharePoint folder. You specify the path to this template in your script. The scripts copy it, fill it with your data, and save the result as a new file in your destination folder. This ensures every upload has consistent formatting.
+
+## Folder Structure
+
+```
+SAP_Automation/
+├── functions/     Core modules that do the actual work (you don't edit these)
+├── templates/     Starter scripts you copy and customize for each SAP transaction
+└── tools/         Utilities like the transaction checker
+```
+
+## Templates
+
+### SAP Pipeline (template_sap_pipeline.py)
+
+The main template. Handles the full workflow: connect to SAP, run your transaction, export data, upload to SharePoint.
+
+```python
+df = run_extract(sap_script,
+    transaction="ZSUPVENG",
+    export_format="xlsx",
+    template_folder=r"Z:\path\to\template_folder",
+    sharepoint_folder=r"Z:\path\to\your_sharepoint_folder",
+)
+```
+
+**How to use:**
+1. Copy this template and rename it (e.g. `ZSUPVENG.py`)
+2. Paste your SAP recording into the `sap_script()` function
+3. Set `transaction` to your transaction code
+4. Set `template_folder` to the SharePoint folder containing your checked-in `.xlsx` template
+5. Set `sharepoint_folder` to where you want the output file saved
+6. Run the script
+
+### SharePoint Upload (template_sharepoint_upload.py)
+
+Uploads any data to SharePoint as a formatted Excel file. No SAP needed. Useful when you already have data in a file or DataFrame and just want to push it to SharePoint.
+
+```python
+result = save_excel_to_sharepoint(df,
+    template_folder=r"Z:\path\to\template_folder",
+    sharepoint_folder=r"Z:\path\to\your_sharepoint_folder",
+    output_filename_prefix="MyReport_2026-01-01",
+)
+```
+
+### Excel Macros (template_excel_macro.py)
+
+Opens an Excel workbook and runs VBA macros by name.
+
+```python
+run_excel_macro(
+    file_path=r"Z:\path\to\your_workbook.xlsm",
+    macro_name="MyMacro",
+    module_name="Module1"
+)
+```
+
+## Core Modules (functions/)
+
+These are the building blocks. You don't need to edit these files.
+
+| File | What it does |
+|------|-------------|
+| `sap_extract.py` | The main engine. Connects to SAP, runs your recording, handles the save dialog, reads the file, uploads to SharePoint |
+| `sap_connection.py` | Opens SAP GUI, connects to PR1, handles popups like "Multiple Logon" |
+| `sharepoint_upload.py` | Copies the checked-in template, writes your data into it, saves it to SharePoint |
+| `excel_macro.py` | Opens an Excel file and runs a VBA macro |
+
+## Export Formats
+
+Your SAP recording should include the export menu clicks (right-click, select format, etc.). The `export_format` setting just tells the engine what file type to expect so it can handle the save dialog correctly.
+
+| Format | What the engine does |
+|--------|---------------------|
+| `"txt"` | Fills in the save dialog, reads the tab-delimited text file |
+| `"xlsx"` | Fills in the save dialog, waits for the file, closes the Excel window SAP opens |
+| `"clipboard"` | No save dialog needed, reads directly from clipboard |
+
+## Tools
+
+**Transaction Checker** (`tools/check_transactions.py`): Scans all your scripts for SAP transaction codes, then connects to SAP and verifies each one opens successfully. Run it with `check_transactions.bat`.

process_automation-1.0.1/README.md

@@ -0,0 +1,108 @@
+# SAP Automation
+
+## What is this?
+
+We regularly need to pull data from SAP, format it as Excel, and upload it to SharePoint. Doing this manually is slow and repetitive. These scripts automate the entire process so you can run a single Python file and have the data extracted, saved, and uploaded automatically.
+
+## Who is this for?
+
+Anyone who needs to extract SAP reports on a recurring basis. You do not need to be a programmer. The templates are designed so you only need to:
+
+1. Record your SAP steps (SAP has a built-in script recorder)
+2. Paste the recording into the template
+3. Fill in a few settings (transaction code, file paths)
+4. Run the script
+
+## How it works
+
+The scripts follow this workflow:
+
+1. Open SAP and connect to PR1
+2. Run your recorded SAP transaction (fill in fields, execute report, click export)
+3. Save the exported file locally
+4. Read the file into memory
+5. Copy a checked-in Excel template from SharePoint, write the data into it, and save it back to SharePoint
+6. Clean up temporary files
+
+The "checked-in file" is an `.xlsx` template that lives in a SharePoint folder. You specify the path to this template in your script. The scripts copy it, fill it with your data, and save the result as a new file in your destination folder. This ensures every upload has consistent formatting.
+
+## Folder Structure
+
+```
+SAP_Automation/
+├── functions/     Core modules that do the actual work (you don't edit these)
+├── templates/     Starter scripts you copy and customize for each SAP transaction
+└── tools/         Utilities like the transaction checker
+```
+
+## Templates
+
+### SAP Pipeline (template_sap_pipeline.py)
+
+The main template. Handles the full workflow: connect to SAP, run your transaction, export data, upload to SharePoint.
+
+```python
+df = run_extract(sap_script,
+    transaction="ZSUPVENG",
+    export_format="xlsx",
+    template_folder=r"Z:\path\to\template_folder",
+    sharepoint_folder=r"Z:\path\to\your_sharepoint_folder",
+)
+```
+
+**How to use:**
+1. Copy this template and rename it (e.g. `ZSUPVENG.py`)
+2. Paste your SAP recording into the `sap_script()` function
+3. Set `transaction` to your transaction code
+4. Set `template_folder` to the SharePoint folder containing your checked-in `.xlsx` template
+5. Set `sharepoint_folder` to where you want the output file saved
+6. Run the script
+
+### SharePoint Upload (template_sharepoint_upload.py)
+
+Uploads any data to SharePoint as a formatted Excel file. No SAP needed. Useful when you already have data in a file or DataFrame and just want to push it to SharePoint.
+
+```python
+result = save_excel_to_sharepoint(df,
+    template_folder=r"Z:\path\to\template_folder",
+    sharepoint_folder=r"Z:\path\to\your_sharepoint_folder",
+    output_filename_prefix="MyReport_2026-01-01",
+)
+```
+
+### Excel Macros (template_excel_macro.py)
+
+Opens an Excel workbook and runs VBA macros by name.
+
+```python
+run_excel_macro(
+    file_path=r"Z:\path\to\your_workbook.xlsm",
+    macro_name="MyMacro",
+    module_name="Module1"
+)
+```
+
+## Core Modules (functions/)
+
+These are the building blocks. You don't need to edit these files.
+
+| File | What it does |
+|------|-------------|
+| `sap_extract.py` | The main engine. Connects to SAP, runs your recording, handles the save dialog, reads the file, uploads to SharePoint |
+| `sap_connection.py` | Opens SAP GUI, connects to PR1, handles popups like "Multiple Logon" |
+| `sharepoint_upload.py` | Copies the checked-in template, writes your data into it, saves it to SharePoint |
+| `excel_macro.py` | Opens an Excel file and runs a VBA macro |
+
+## Export Formats
+
+Your SAP recording should include the export menu clicks (right-click, select format, etc.). The `export_format` setting just tells the engine what file type to expect so it can handle the save dialog correctly.
+
+| Format | What the engine does |
+|--------|---------------------|
+| `"txt"` | Fills in the save dialog, reads the tab-delimited text file |
+| `"xlsx"` | Fills in the save dialog, waits for the file, closes the Excel window SAP opens |
+| `"clipboard"` | No save dialog needed, reads directly from clipboard |
+
+## Tools
+
+**Transaction Checker** (`tools/check_transactions.py`): Scans all your scripts for SAP transaction codes, then connects to SAP and verifies each one opens successfully. Run it with `check_transactions.bat`.

process_automation-1.0.1/functions/excel_macro.py

@@ -0,0 +1,43 @@
+# Excel Macro Runner
+# ==================
+# Opens an Excel file (even if already open) and runs a VBA macro by name.
+#
+# Usage:
+#   from excel_macro import run_excel_macro
+#
+#   run_excel_macro(
+#       file_path=r"Z:\some_folder\my_workbook.xlsm",
+#       macro_name="MyMacroName",
+#       module_name="Module1"       # optional — prefix with module name
+#   )
+
+import win32com.client
+import os
+
+
+def run_excel_macro(file_path: str, macro_name: str, module_name: str = None):
+    """Open an Excel file (or attach to it if already open) and run a macro by name."""
+    file_path = os.path.abspath(file_path)
+    filename = os.path.basename(file_path)
+
+    excel = win32com.client.Dispatch("Excel.Application")
+    excel.Visible = True
+
+    # Check if the workbook is already open
+    wb = None
+    for i in range(excel.Workbooks.Count):
+        if excel.Workbooks(i + 1).Name.lower() == filename.lower():
+            wb = excel.Workbooks(i + 1)
+            break
+
+    if wb is None:
+        wb = excel.Workbooks.Open(file_path)
+
+    # Run the macro
+    if module_name:
+        macro_ref = f"'{wb.Name}'!{module_name}.{macro_name}"
+    else:
+        macro_ref = f"'{wb.Name}'!{macro_name}"
+
+    excel.Application.Run(macro_ref)
+    print(f"Macro '{macro_name}' executed successfully.")

process_automation-1.0.1/functions/sap_connection.py

@@ -0,0 +1,196 @@
+# SAP GUI Connection Manager
+# ===========================
+# Provides the SAPManager class to automate SAP GUI connections via COM scripting.
+#
+# Usage:
+#   sap = SAPManager()
+#   session = sap.get_session()    # Opens SAP GUI, connects to PR1, returns a session
+#   ... (run your SAP script) ...
+#   sap.close_connection(session)  # Logs off and closes the SAP window
+#
+# What get_session() does:
+#   1. Connects to an existing SAP GUI instance, or launches a new one if none is running
+#   2. Opens a NEW connection to the PR1 server (never reuses existing sessions)
+#   3. Handles the "Multiple Logon" popup automatically
+#   4. Handles the session manager screen if it appears instead of Easy Access
+#   5. Returns the session object used to script SAP GUI actions (findById, press, etc.)
+#
+# Other methods:
+#   - return_to_main_menu(session)  : sends /n and waits until Easy Access screen appears
+#   - close_connection(session)     : sends /nex to log off (only closes this script's connection)
+
+import subprocess
+import os
+import platform
+import time
+import win32com.client
+
+class SAPManager:
+    def __init__(self, connection_name="-PR1 [PWC SAP ECC 6.0]", xml_name="PWC_SAPUILandscape.xml"):
+        self.connection_name = connection_name
+        self.xml_name = xml_name
+        self.session = None
+        self.connection = None
+        self.application = None
+    
+    def _handle_session_manager_screen(self, session):
+        """Navigate past the session manager screen if it appears.
+
+        Sometimes SAP opens to a screen titled just 'SAP' with a
+        'Start SAP Easy Access' button instead of going directly to the
+        main menu. Tries multiple approaches to click through.
+        """
+        try:
+            title = session.findById("wnd[0]").text
+            if "Easy Access" in title:
+                return  # Already on the main menu
+            print(f"Session manager screen detected (title: '{title}'). Clicking through...")
+
+            # Try to find and click the 'Start SAP Easy Access' button
+            # by scanning all children in the user area
+            try:
+                usr = session.findById("wnd[0]/usr")
+                for i in range(usr.Children.Count):
+                    child = usr.Children(i)
+                    try:
+                        child_text = child.text if hasattr(child, 'text') else ""
+                        if "Easy Access" in child_text or "Start" in child_text:
+                            child.press()
+                            time.sleep(2)
+                            print(f"Clicked '{child_text}' button (id: {child.id}).")
+                            return
+                    except Exception:
+                        continue
+            except Exception:
+                pass
+
+            # Fallback: press Enter which may activate the default button
+            try:
+                session.findById("wnd[0]").sendVKey(0)
+                time.sleep(2)
+                print("Pressed Enter to pass session manager screen.")
+            except Exception:
+                pass
+        except Exception as e:
+            print(f"Warning: Could not handle session manager screen: {e}")
+
+    def return_to_main_menu(self, session, timeout=5):
+        """Navigate back to main menu and wait until it's confirmed.
+
+        Sends /n and polls until the SAP Easy Access main menu is detected
+        (title contains 'Easy Access'). This serves as a reliable signal
+        that the previous transaction has fully completed.
+
+        Returns True if main menu reached, False on timeout.
+        """
+        try:
+            session.findById("wnd[0]/tbar[0]/okcd").text = "/n"
+            session.findById("wnd[0]").sendVKey(0)
+        except Exception as e:
+            print(f"Warning: Could not send /n command: {e}")
+            return False
+
+        start = time.time()
+        while time.time() - start < timeout:
+            try:
+                title = session.findById("wnd[0]").text
+                if "Easy Access" in title:
+                    print("Returned to SAP main menu.")
+                    return True
+            except Exception:
+                pass
+            time.sleep(0.5)
+
+        print(f"Warning: Timed out waiting for main menu after {timeout}s.")
+        return False
+    
+    def close_connection(self, session):
+        """Close the connection this script opened.
+
+        Sends /nex to log off and close the SAP window, then clears
+        internal references. Only affects this script's connection —
+        other connections remain untouched.
+
+        Returns True if closed successfully, False on error.
+        """
+        try:
+            session.findById("wnd[0]/tbar[0]/okcd").text = "/nex"
+            session.findById("wnd[0]").sendVKey(0)
+            print(f"[{self.connection_name}] Connection closed.")
+            self.session = None
+            self.connection = None
+            return True
+        except Exception as e:
+            print(f"Warning: Could not close connection: {e}")
+            return False
+
+    def _handle_multiple_logon_popup(self, session=None):
+        """Internal helper to allow the multiple logon (continue with current session)."""
+        session = session or self.session
+        try:
+            popup = session.findById("wnd[1]", False)
+            if popup is not None:
+                if "License Information" in popup.text or "Multiple Logon" in popup.text:
+                    session.findById("wnd[1]/usr/radMULTI_LOGON_OPT2").Select()
+                    session.findById("wnd[1]/tbar[0]/btn[0]").press()
+                    print(f"[{self.connection_name}] Allowed Multiple Logon - new session created.")
+        except Exception:
+            pass
+    
+    def get_session(self):
+        if platform.system() != "Windows":
+            raise RuntimeError("Windows OS is required for SAP GUI Scripting.")
+        
+        # 1. Connect to existing SAP GUI or start new one
+        try:
+            try:
+                sap_gui_auto = win32com.client.GetObject("SAPGUI")
+                self.application = sap_gui_auto.GetScriptingEngine
+                print("Connected to existing SAP GUI instance.")
+            except Exception:
+                # No SAP GUI running — start it
+                exe_path = r"C:\Program Files\SAP\FrontEnd\SAPGUI\saplgpad.exe"
+                xml_full_path = os.path.expandvars(rf"%ProgramFiles%\SAP\PWCConfig\{self.xml_name}")
+
+                if not os.path.exists(exe_path):
+                    raise FileNotFoundError(f"SAP Executable not found at {exe_path}")
+
+                subprocess.Popen(f'"{exe_path}" /LSXML_FILE="{xml_full_path}"', shell=True)
+
+                # Poll until SAP GUI is available instead of fixed sleep
+                for _ in range(15):
+                    time.sleep(1)
+                    try:
+                        sap_gui_auto = win32com.client.GetObject("SAPGUI")
+                        self.application = sap_gui_auto.GetScriptingEngine
+                        break
+                    except Exception:
+                        continue
+                else:
+                    raise RuntimeError("SAP GUI did not become available within 15 seconds")
+                print("Started new SAP GUI instance.")
+        except Exception as e:
+            raise RuntimeError(f"Failed to connect to SAP GUI: {e}")
+
+        # 2. Always open a new connection to avoid interfering with
+        #    other scripts that may be using existing sessions
+        for attempt in range(2):
+            try:
+                print(f"[{self.connection_name}] Opening new connection...")
+                self.connection = self.application.OpenConnection(self.connection_name, True)
+                time.sleep(2)
+                self.session = self.connection.Children(0)
+                self._handle_multiple_logon_popup()
+                print(f"New connection opened with 1 session")
+                break
+            except Exception as e:
+                if attempt == 0:
+                    print(f"Connection attempt failed, retrying: {e}")
+                    time.sleep(3)
+                else:
+                    raise ConnectionError(f"Could not open new connection to {self.connection_name}: {str(e)}")
+
+        # Handle session manager screen if it appears instead of Easy Access
+        self._handle_session_manager_screen(self.session)
+
+        return self.session