This is a solid automation project. To make it professional for GitHub, the README should clearly explain what the tool does, the prerequisites (since SAP and Google APIs require specific setups), and how to configure it without hardcoding credentials.
Here is a professional README.md template tailored to your project.
SAP MM01 QM-View Automation: A Python and Google Apps Script (GAS) based automation tool that synchronizes procurement data from Smartsheet to Google Sheets, and then uses Python RPA to automatically maintain Quality Management (QM) views in SAP ERP.
Workflow: Data Sync (GAS): Fetches filtered outsource procurement data from Smartsheet and populates a Google Sheet.
Task Filtering (Python): Identifies pending materials (prefixed with 'P') that haven't been processed.
SAP RPA (Python/GUI Scripting): * Logs into SAP automatically.
Executes transaction MM01.
Selects the Quality Management view.
Maintains Inspection Types (89 and Z01).
Logging: Updates the Google Sheet status to "success" and logs completed entries.
Prerequisites:
- SAP Environment SAP GUI installed on Windows.
Scripting API must be enabled on both the client and server side.
The saplogon.exe path should match the configuration in the script.
- Google Cloud Platform A Service Account created via the Google Cloud Console.
Download the JSON key file and rename it to credentials.json.
Enable Google Sheets API and Google Drive API.
Installation: Clone the repository:
Bash pip install pywin32 gspread oauth2client Google Apps Script Setup:
Create a new script in your Google Sheet.
Copy the code from sync_logic.gs.
Set up Script Properties for SMARTSHEET_TOKEN, SMARTSHEET_ID, etc.
Configuration: To protect your credentials, this project uses Environment Variables. Do not hardcode your password in the script.
Windows (PowerShell) PowerShell env:SAP_USER="YourUserName" env:SAP_PASSWORD="YourSecretPassword" env:SAP_SYSTEM_NAME="YourSystemID" env:GS_SHEET_KEY="YourGoogleSheetID" File Structure automation.py: The main Python RPA logic.
sync_logic.gs: Google Apps Script for Smartsheet integration.
credentials.json: (Not included) Your Google Service Account key.
.gitignore: Prevents sensitive files from being uploaded.
Safety & Security: Credential Masking: This repository uses environment variables and external JSON files for authentication.
Token Rotation: If you accidentally commit a token, revoke it immediately in the Smartsheet/Google admin console.
SAP GUI Scripting: Use caution when running RPA on production environments. Ensure the select_material_view logic matches your specific SAP GUI theme/version.
License Distributed under the MIT License. See LICENSE for more information.