|
1 | | -# RPAForge Libraries |
2 | | - |
3 | | -## Overview |
4 | | - |
5 | | -RPAForge provides 14 specialized libraries covering all aspects of robotic process automation. Each library delivers targeted functionality with consistent APIs for building robust automation workflows. |
6 | | - |
7 | | -## Library Reference |
8 | | - |
9 | | -| Library | Keywords | Description | |
10 | | -|---------|----------|-------------| |
11 | | -| [DesktopUI](desktopui.md) | 58 | Windows desktop automation using pywinauto | |
12 | | -| [WebUI](webui.md) | 60 | Browser automation using Playwright | |
13 | | -| [Excel](excel.md) | 34 | Excel file operations using openpyxl | |
14 | | -| [DataFrames](dataframes.md) | 28 | Tabular data operations using Polars | |
15 | | -| [Database](database.md) | 19 | Database operations using SQLAlchemy | |
16 | | -| [File](file.md) | 18 | File system operations | |
17 | | -| [HTTP](http.md) | 14 | HTTP/API operations using requests | |
18 | | -| [OCR](ocr.md) | 12 | Text recognition using Tesseract | |
19 | | -| [Credentials](credentials.md) | 14 | Secure credential management | |
20 | | -| [DateTime](datetime.md) | 16 | Date and time operations | |
21 | | -| [String](string.md) | 19 | String manipulation operations | |
22 | | -| [Variables](variables.md) | 19 | Variable management and scoping | |
23 | | -| [Flow](flow.md) | 8 | Flow control operations | |
24 | | -| [Spy](spy.md) | 3 | Live UI element inspector | |
25 | | - |
26 | | -## Writing Your Own Library |
27 | | - |
28 | | -Want to add a library of your own — for an internal system, a niche |
29 | | -automation target, or just to scratch your own itch? See |
30 | | -[Writing a Custom RPAForge Library](../developer-guide/writing-a-library.md) |
31 | | -— libraries register via Python entry points, so no changes to RPAForge |
32 | | -itself are required. |
33 | | - |
34 | | -## Installation |
35 | | - |
36 | | -```bash |
37 | | -pip install rpaforge-libraries |
38 | | - |
39 | | -# Optional dependencies |
40 | | -pip install rpaforge-libraries[desktop] # DesktopUI (pywinauto) |
41 | | -pip install rpaforge-libraries[web] # WebUI (playwright) |
42 | | -pip install rpaforge-libraries[ocr] # OCR (tesseract) |
43 | | -pip install rpaforge-libraries[excel] # Excel (openpyxl) |
44 | | -pip install rpaforge-libraries[dataframes] # DataFrames (polars) |
45 | | -pip install rpaforge-libraries[database] # Database (sqlalchemy) |
46 | | -pip install rpaforge-libraries[all] # All dependencies |
47 | | -``` |
48 | | - |
49 | | -## Usage Example |
50 | | - |
51 | | -```python |
52 | | -from rpaforge import StudioEngine |
53 | | -from rpaforge_libraries.DesktopUI import DesktopUI |
54 | | -from rpaforge_libraries.Excel import Excel |
55 | | - |
56 | | -engine = StudioEngine() |
57 | | -builder = engine.create_process("My Automation") |
58 | | -builder.add_task("My Task", [ |
59 | | - ("DesktopUI.Open Application", {"executable": "notepad.exe"}), |
60 | | - (" Excel.Read Cell", {"cell": "A1"}), |
61 | | -]) |
62 | | - |
63 | | -result = engine.run(builder.build()) |
64 | | -``` |
65 | | - |
66 | | -## Supported Keywords by Category |
67 | | - |
68 | | -### Desktop |
69 | | -- DesktopUI: 27 keywords |
70 | | - |
71 | | -### Web |
72 | | -- WebUI: 21 keywords |
73 | | - |
74 | | -### Data |
75 | | -- Excel: 17 keywords |
76 | | -- DataFrames: 28 keywords |
77 | | -- Database: 13 keywords |
78 | | -- DateTime: 16 keywords |
79 | | -- String: 15 keywords |
80 | | -- Variables: 19 keywords |
81 | | - |
82 | | -### System |
83 | | -- File: 18 keywords |
84 | | -- Flow: 7 keywords |
85 | | -- Credentials: 14 keywords |
86 | | - |
87 | | -### Advanced |
88 | | -- OCR: 12 keywords |
89 | | -- HTTP: 14 keywords |
| 1 | +# RPAForge Libraries |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +RPAForge provides 14 specialized libraries covering all aspects of robotic process automation. Each library delivers targeted functionality with consistent APIs for building robust automation workflows. |
| 6 | + |
| 7 | +## Library Reference |
| 8 | + |
| 9 | +| Library | Keywords | Description | |
| 10 | +|---------|----------|-------------| |
| 11 | +| [DesktopUI](desktopui.md) | 58 | Windows desktop automation using pywinauto | |
| 12 | +| [WebUI](webui.md) | 60 | Browser automation using Playwright | |
| 13 | +| [Excel](excel.md) | 34 | Excel file operations using openpyxl | |
| 14 | +| [DataFrames](dataframes.md) | 28 | Tabular data operations using Polars | |
| 15 | +| [Database](database.md) | 19 | Database operations using SQLAlchemy | |
| 16 | +| [File](file.md) | 18 | File system operations | |
| 17 | +| [HTTP](http.md) | 14 | HTTP/API operations using requests | |
| 18 | +| [OCR](ocr.md) | 12 | Text recognition using Tesseract | |
| 19 | +| [Credentials](credentials.md) | 14 | Secure credential management | |
| 20 | +| [DateTime](datetime.md) | 16 | Date and time operations | |
| 21 | +| [String](string.md) | 19 | String manipulation operations | |
| 22 | +| [Variables](variables.md) | 19 | Variable management and scoping | |
| 23 | +| [Flow](flow.md) | 8 | Flow control operations | |
| 24 | +| [Spy](spy.md) | 3 | Live UI element inspector | |
| 25 | + |
| 26 | +## Writing Your Own Library |
| 27 | + |
| 28 | +Want to add a library of your own — for an internal system, a niche |
| 29 | +automation target, or just to scratch your own itch? See |
| 30 | +[Writing a Custom RPAForge Library](../developer-guide/writing-a-library.md) |
| 31 | +— libraries register via Python entry points, so no changes to RPAForge |
| 32 | +itself are required. |
| 33 | + |
| 34 | +## Installation |
| 35 | + |
| 36 | +```bash |
| 37 | +pip install rpaforge-libraries |
| 38 | + |
| 39 | +# Optional dependencies |
| 40 | +pip install rpaforge-libraries[desktop] # DesktopUI (pywinauto) |
| 41 | +pip install rpaforge-libraries[web] # WebUI (playwright) |
| 42 | +pip install rpaforge-libraries[ocr] # OCR (tesseract) |
| 43 | +pip install rpaforge-libraries[excel] # Excel (openpyxl) |
| 44 | +pip install rpaforge-libraries[dataframes] # DataFrames (polars) |
| 45 | +pip install rpaforge-libraries[database] # Database (sqlalchemy) |
| 46 | +pip install rpaforge-libraries[all] # All dependencies |
| 47 | +``` |
| 48 | + |
| 49 | +## Usage Example |
| 50 | + |
| 51 | +```python |
| 52 | +from rpaforge import StudioEngine |
| 53 | +from rpaforge_libraries.DesktopUI import DesktopUI |
| 54 | +from rpaforge_libraries.Excel import Excel |
| 55 | + |
| 56 | +engine = StudioEngine() |
| 57 | +builder = engine.create_process("My Automation") |
| 58 | +builder.add_task("My Task", [ |
| 59 | + ("DesktopUI.Open Application", {"executable": "notepad.exe"}), |
| 60 | + (" Excel.Read Cell", {"cell": "A1"}), |
| 61 | +]) |
| 62 | + |
| 63 | +result = engine.run(builder.build()) |
| 64 | +``` |
| 65 | + |
| 66 | +## Supported Keywords by Category |
| 67 | + |
| 68 | +### Desktop |
| 69 | +- DesktopUI: 27 keywords |
| 70 | + |
| 71 | +### Web |
| 72 | +- WebUI: 21 keywords |
| 73 | + |
| 74 | +### Data |
| 75 | +- Excel: 17 keywords |
| 76 | +- DataFrames: 28 keywords |
| 77 | +- Database: 13 keywords |
| 78 | +- DateTime: 16 keywords |
| 79 | +- String: 15 keywords |
| 80 | +- Variables: 19 keywords |
| 81 | + |
| 82 | +### System |
| 83 | +- File: 18 keywords |
| 84 | +- Flow: 7 keywords |
| 85 | +- Credentials: 14 keywords |
| 86 | + |
| 87 | +### Advanced |
| 88 | +- OCR: 12 keywords |
| 89 | +- HTTP: 14 keywords |
0 commit comments