# RPALite - An Open Source RPA (Robotic Process Automation) Programming Library for Python and Robot Framework

| [English](README.md) | [中文](README-zh.md) |

[![PyPI](https://img.shields.io/pypi/v/RPALite?color=blue&label=PyPI%20Package)](https://pypi.org/project/RPALite/)
[![License](https://img.shields.io/github/license/jieliu2000/RPALite)](https://github.com/jieliu2000/RPALite/blob/main/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/RPALite)](https://www.python.org/downloads/)

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Platform Support](#platform-support)
- [Installation](#installation)
- [Quick Start](#quick-start)
  - [Python](#python)
  - [Robot Framework](#robot-framework)
- [Documentation](#documentation)
- [OCR Engine Options](#ocr-engine-options)
  - [Automatic Language Detection](#automatic-language-detection)
  - [Manual Language Configuration](#manual-language-configuration)
- [Performance Optimization](#performance-optimization)
- [Contribution Guidelines](#contribution-guidelines)
- [macOS Configuration Guide](#macos-configuration-guide)

## Introduction

RPALite is an open-source RPA (Robotic Process Automation) library. You can use RPALite through Python or [Robot Framework](https://robotframework.org/) to achieve various automation tasks with minimal code.

RPALite provides powerful automation capabilities with a simple API, allowing you to automate UI interactions, data entry, and image-based operations across different applications.

RPALite currently only supports the Windows platform. Support for macOS and Linux is under active development.

## Features

RPALite supports the following operations:

- **Application Management**

  - Launching applications
  - Finding applications by name or class name
  - Closing applications (with force quit option)
  - Window management (maximize, minimize, show desktop)

- **Mouse Operations**

  - Clicking by coordinates, text or images
  - Support for left-click, right-click, and double-click operations
  - Mouse press/release for drag and drop operations
  - Scrolling operations
  - Moving cursor to text elements

- **Keyboard Operations**

  - Text input at cursor position
  - Advanced keyboard input with special keys and combinations
  - Text field interaction based on labels

- **Visual Automation**

  - OCR-based text recognition (multiple language support)
  - Image-based location and verification
  - Finding all instances of an image on screen
  - Waiting for text or images to appear/disappear
  - Screen recording capabilities

- **UI Automation**

  - Finding controls by label, text vicinity, or automated IDs
  - Flexible UI element locator system
  - Control interaction based on element properties

- **Utility Features**
  - Clipboard operations (get/set)
  - Screenshot capabilities
  - Synchronization mechanisms (waits and sleeps)

## Platform Support

### Windows

- Full automation support including UI controls
- Windows-specific features like UI Automation
- Administrative privileges may be required for some features

### macOS (Under Development)

- Basic macOS automation support is now available
- Key features supported:
  - Application launching and window management
  - Keyboard and mouse input
  - Screen capture and OCR text detection
  - Clipboard operations
- **Important**: Requires system permissions (Screen Recording, Accessibility, Automation)
- **Setup Guide**: See [macOS Configuration Guide](#macos-configuration-guide) for detailed setup instructions
- Known limitations: Limited UI element identification and application-specific automation

### Linux

- Full automation support for X11-based desktop environments
- Requires X Window System (X11) and a graphical desktop environment
- System dependencies:
  - xdotool: For keyboard and mouse simulation
  - wmctrl: For window management
  - python-xlib: For X11 interaction
- Installation of system dependencies:

  ```bash
  # Ubuntu/Debian
  sudo apt-get install xdotool wmctrl python3-xlib

  # CentOS/RHEL
  sudo yum install xdotool wmctrl python3-xlib

  # Arch Linux
  sudo pacman -S xdotool wmctrl python-xlib
  ```

### Linux (Planned)

- Linux support is planned for future releases
- Currently in early design phase

## Installation

You can install RPALite via pip:

```bash
pip install RPALite
```

Platform-specific dependencies will be automatically installed based on your operating system.

## Quick Start

As mentioned earlier, you can use RPALite with Python or Robot Framework. Here are some examples:

### Python

#### Basic Example

Below is an example of using RPALite to operate Windows Notepad:

```python
from RPALite import RPALite
rpalite = RPALite()

# Show the desktop
rpalite.show_desktop()

# Run Notepad and input some text
rpalite.run_command("notepad.exe")
rpalite.input_text("This is a demo using RPALite.\n")

# Find the Notepad app and close it
app = rpalite.find_application(".*Notepad")
rpalite.close_app(app)
```

### Advanced Keyboard Input Examples

```python
# Simple text input
rpalite.send_keys("Hello World")

# Special keys
rpalite.send_keys("{ENTER}")
rpalite.send_keys("{ESC}")

# Key combinations
rpalite.send_keys("^c")          # Control+C
rpalite.send_keys("%{F4}")       # Alt+F4
rpalite.send_keys("+(abc)")      # Shift+ABC (uppercase)
```

### Robot Framework

#### Basic Example

Below is an example of using RPALite to operate Windows Notepad:

```robotframework
*** Settings ***
Library    RPALite

*** Test Cases ***
Test Notepad
    Send Keys    {VK_LWIN down}D{VK_LWIN up}
    Run Command    notepad.exe
    ${app} =     Find Application    .*Notepad
    Maximize Window    ${app}
    Input Text    This is a demo using RPALite.
    Close App    ${app}
```

#### Advanced Features Example

```robotframework
*** Settings ***
Library    RPALite
Library    OperatingSystem

*** Test Cases ***
Login Form Automation
    # Wait for text to appear with timeout
    ${position} =    Wait Until Text Shown    Login    timeout=10

    # Click on UI elements
    Click By Text    Sign In

    # Fill in form fields
    Enter In Field    Username    my_user
    Enter In Field    Password    my_password

    # Take screenshot for verification
    ${screenshot} =    Take Screenshot    filename=login_screen.png

    # Wait for an image to appear on screen
    Wait Until Image Shown    dashboard_icon.png    timeout=15

    # Start screen recording
    ${recording_path} =    Start Screen Recording    fps=15

    # Perform test operations
    Click By Text    Dashboard
    Sleep    2

    # Validate text exists on screen
    Validate Text Exists    Welcome, my_user

    # Stop recording
    ${final_path} =    Stop Screen Recording
    Log    Recording saved to: ${final_path}
```

#### Advanced Keyboard Input Example

```robotframework
*** Settings ***
Library    RPALite

*** Test Cases ***
Keyboard Operations
    # Simple text input
    Input Text    Hello from Robot Framework!

    # Special keys and combinations
    Send Keys    {ENTER}
    Send Keys    ^a    # Select all
    Send Keys    ^c    # Copy
    Send Keys    {TAB}
    Send Keys    ^v    # Paste

    # Function keys and modifiers
    Send Keys    {F5}
    Send Keys    %{F4}    # Alt+F4

    # Get clipboard content
    ${clipboard_text} =    Get Clipboard Text
    Log    Clipboard contains: ${clipboard_text}
```

## Documentation

Here are links to detailed documentation:

- [Programming Guide for Using RPALite in Python](docs/en/python/guide.md)
- [Programming Guide for Using RPALite in Robot Framework](docs/en/robot/guide.md)

In addition to the above documents, we provide an English version of the Robot Framework Library documentation, which you can access through the [Online Robot Framework Documentation](https://jieliu2000.github.io/RPALite/docs/en/robot/RPALite.html). If you prefer to view it locally, you can open the [Robot Framework Library documentation in the project directory](docs/en/robot/RPALite.html).

## OCR Engine Options

RPALite supports two OCR engines for text recognition:

- **EasyOCR** (Default)

  - Better multi-language support
  - Suitable for general-purpose OCR tasks
  - Larger model size

- **PaddleOCR**
  - Better performance for Chinese text
  - Smaller model size
  - Faster inference speed

You can specify which engine to use during initialization:

```python
# Using the default (EasyOCR)
rpa = RPALite()

# Using PaddleOCR
rpa = RPALite(ocr_engine="paddleocr")
```

### Language Configuration

#### Automatic Language Detection

RPALite automatically detects your operating system's display language and adds appropriate language support for OCR engines. For example, if your system is set to Chinese, Chinese language support will be automatically added to improve text recognition accuracy. This feature works with both EasyOCR and PaddleOCR engines.

#### Manual Language Configuration

You can also manually specify languages for OCR recognition:

```python
# For EasyOCR
rpa = RPALite(ocr_engine="easyocr", languages=["en", "ch_sim", "fr"])

# For PaddleOCR
rpa = RPALite(ocr_engine="paddleocr", languages=["en", "ch", "fr"])
```

**Language Code References:**

- **EasyOCR**: [Supported Languages](https://github.com/JaidedAI/EasyOCR#supported-languages)
- **PaddleOCR**: [Language Support](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.7/doc/doc_en/multi_languages_en.md)

## Performance Optimization

The most time-consuming operations in RPALite are image recognition and OCR. Both OCR engines run more efficiently on computers with dedicated GPUs and CUDA support. If you find RPALite running slowly, consider running it on a computer with a dedicated GPU and CUDA support and installing the appropriate version of PyTorch.

## Contribution Guidelines

If you wish to contribute code to RPALite, feel free to submit a Pull Request. Ensure your code style is consistent with the existing codebase and passes all tests in the tests directory. Additionally, make sure to update unit tests for any new or modified code.

- GitHub Repository: https://github.com/jieliu2000/RPALite
- Gitee Repository: https://gitee.com/jieliu2000/rpalite
- Gitcode Repository: https://gitcode.com/jieliu2000/rpalite

## macOS Configuration Guide

This section provides detailed setup instructions for using RPALite on macOS.

### System Requirements

- macOS 10.14 or later recommended
- Python 3.7 or later
- Required system dependencies (automatically installed with RPALite)

### System Dependencies

RPALite requires the following macOS-specific dependencies:

- **pyobjc-core**: Core Objective-C bindings
- **pyobjc-framework-Cocoa**: AppKit and Foundation frameworks
- **pyobjc-framework-Quartz**: Screen capture and image processing
- **pyobjc-framework-ApplicationServices**: Accessibility and user input

These dependencies are automatically installed when you install RPALite via pip. If you need to install them manually:

```bash
pip install pyobjc-core pyobjc-framework-Cocoa pyobjc-framework-Quartz pyobjc-framework-ApplicationServices
```

### System Permission Setup

To use RPALite on macOS, you need to grant the necessary permissions in System Settings:

#### 1. Screen Recording Permission

- Go to System Settings > Privacy & Security > Screen Recording
- Click the "+" button to add applications
- For Terminal:
  - Navigate to `/Applications/Utilities/Terminal.app`
  - Select Terminal and click "Open"
- For VSCode:
  - Navigate to `/Applications/Visual Studio Code.app` (or your custom installation location)
  - Select VSCode and click "Open"
- Restart Terminal or VSCode after adding them
- This permission is required for taking screenshots and OCR functionality

#### 2. Accessibility Permission

- Go to System Settings > Privacy & Security > Accessibility
- Click the "+" button to add applications
- For Terminal:
  - Navigate to `/Applications/Utilities/Terminal.app`
  - Select Terminal and click "Open"
- For VSCode:
  - Navigate to `/Applications/Visual Studio Code.app`
  - Select VSCode and click "Open"
- Make sure the checkboxes next to Terminal and VSCode are checked
- This permission is required for mouse and keyboard simulation

#### 3. Automation Permission

- These permissions are requested dynamically when your script attempts to control an application
- When prompted, click "OK" to allow your script to control the target application
- To pre-approve applications (optional):
  - Go to System Settings > Privacy & Security > Automation
  - You'll see a list of applications that can control other apps
  - Check the boxes for the apps you want to allow Terminal or VSCode to control

#### 4. Adding Python Directly (Alternative Method)

- If running scripts directly with Python and not through Terminal/VSCode:
  - Find your Python installation (usually in `/usr/local/bin/python3` or within a virtual environment)
  - Add this Python executable to both Screen Recording and Accessibility permissions
- If using Homebrew Python:
  - Add `/opt/homebrew/bin/python3` (for Apple Silicon) or `/usr/local/bin/python3` (for Intel Macs)

**Note**: The exact path to these settings may vary slightly depending on your macOS version. In older macOS versions, these settings are in System Preferences > Security & Privacy > Privacy.

### Troubleshooting Tips

If you encounter issues when running RPALite on macOS:

#### Permission Errors

- Ensure your terminal/IDE has the required permissions (see System Permission Setup above)
- Try running your script with administrator privileges using `sudo python your_script.py`
- If prompted for application control, always click "OK"

#### OCR or Screenshot Issues

- Verify Screen Recording permission is granted for your terminal/IDE
- Try using a different OCR engine: `rpalite = RPALite(ocr_engine="paddleocr")`
- For poor text recognition, adjust screen resolution or increase font size

#### Mouse/Keyboard Control Issues

- Verify Accessibility permission is granted
- Use absolute coordinates for clicking if text-based clicking fails
- For keyboard input issues, try using `send_keys()` method instead of `input_text()`

#### Application Launch Problems

- Specify the full path to the application if `run_command()` fails
- For some apps, use the full name with `.app` extension: `"Calculator.app"`
- Check if the application bundle name is correct

### Known Limitations

- No UI element identification through accessibility frameworks yet
- Limited support for application-specific automation
- Some features may require additional permissions in System Settings > Privacy & Security
