|
1 | | -### AutoControl |
| 1 | +# AutoControl |
2 | 2 |
|
3 | | -[](https://pepy.tech/project/je-auto-control) |
| 3 | +AutoControl is a cross‑platform GUI automation framework that provides powerful and efficient features for mouse, keyboard, and image‑based automation. |
4 | 4 |
|
5 | | -[](https://www.codacy.com/gh/JE-Chen/AutoControl/dashboard?utm_source=github.com&utm_medium=referral&utm_content=JE-Chen/AutoControl&utm_campaign=Badge_Grade) |
| 5 | +## Features |
6 | 6 |
|
7 | | -[](https://github.com/Intergration-Automation-Testing/AutoControl/actions/workflows/stable_python3_8.yml) |
| 7 | +* Powerful and practical GUI automation. |
| 8 | +* Image recognition (template matching). |
| 9 | +* Coordinate‑based operations. |
| 10 | +* Mouse automation. |
| 11 | +* Keyboard automation. |
| 12 | +* Locate images. |
| 13 | +* AutoControl scripting support. |
| 14 | +* Generate JSON / HTML / XML reports. |
| 15 | +* Remote automation support. |
| 16 | +* Shell command integration. |
| 17 | +* Screenshot support. |
| 18 | +* OS‑independent design. |
| 19 | +* Project & template management. |
8 | 20 |
|
9 | | -[](https://github.com/Intergration-Automation-Testing/AutoControl/actions/workflows/stable_python3_9.yml) |
| 21 | +## ⚠️ Notice |
| 22 | +Currently Unix/Linux Wayland GUI is not supported. |
| 23 | +This may be added as a future feature. |
10 | 24 |
|
11 | | -[](https://github.com/Intergration-Automation-Testing/AutoControl/actions/workflows/stable_python3_10.yml) |
12 | | - |
13 | | -[](https://github.com/Intergration-Automation-Testing/AutoControl/actions/workflows/stable_python3_11.yml) |
14 | | - |
15 | | -### Documentation |
16 | | -[](https://autocontrol.readthedocs.io/en/latest/?badge=latest) |
17 | | - |
18 | | -[AutoControl Doc Click Here!](https://autocontrol.readthedocs.io/en/latest/) |
19 | | - |
20 | | ---- |
21 | | - |
22 | | -> Project Kanban \ |
23 | | -> https://github.com/orgs/Integration-Automation/projects/2/views/1 \ |
24 | | -> * Powerful and useful GUI Automation. |
25 | | -> * Image recognition. |
26 | | -> * Coordinate-based. |
27 | | -> * Mouse automation. |
28 | | -> * Keyboard automation. |
29 | | -> * Locate image less than 0.5 sec. |
30 | | -> * AutoControl script. |
31 | | -> * Generate JSON/HTML/XML report. |
32 | | -> * Remote Automation support. |
33 | | -> * 1 sec / thousands keyboard event. |
34 | | -> * 1 sec / thousands mouse event. |
35 | | -> * Open another process support. |
36 | | -> * Shell command support. |
37 | | -> * Screenshot support. |
38 | | -> * OS Independent. |
39 | | -> * Project & Template support. |
40 | | -
|
41 | | ---- |
42 | | - |
43 | | -### NOTICE |
44 | | -> We don't support Unix/Linux Wayland GUI Now \ |
45 | | -> May be future feature |
46 | | ---- |
47 | | - |
48 | | -## install |
| 25 | +## Installation |
49 | 26 |
|
50 | 27 | ``` |
51 | 28 | # make sure you have install cmake libssl-dev (on linux) |
52 | 29 | pip install je_auto_control |
53 | 30 | ``` |
54 | 31 |
|
55 | | -## Info |
| 32 | +## Requirements |
| 33 | + |
| 34 | +* Python 3.9 or later |
| 35 | +* pip 19.3 or later |
56 | 36 |
|
57 | | -> * requirement |
58 | | ->> * Python 3.9 or later |
59 | | ->> * pip 19.3 or later |
60 | 37 |
|
61 | | -> * Dev env |
62 | | ->> * windows 11 |
63 | | ->> * osx 11 big sur |
64 | | ->> * ubuntu 20.0.4 |
65 | 38 |
|
| 39 | +## Development Environment |
| 40 | +* Windows 11 |
| 41 | +* macOS 11 Big Sur |
| 42 | +* Ubuntu 20.04 |
66 | 43 |
|
67 | | -> * Test on |
68 | | ->> * Windows 10 ~ 11 |
69 | | ->> * osx 10.5 ~ 11 big sur |
70 | | ->> * ubuntu 20.0.4 |
71 | | ->> * raspberry pi 3B and 4B |
| 44 | +## Tested On |
| 45 | +* Windows 10 ~ 11 |
| 46 | +* macOS 10.15 ~ 11 Big Sur |
| 47 | +* Ubuntu 20.04 |
| 48 | +* Raspberry Pi 3B / 4B |
| 49 | + |
| 50 | +## Setting Up Development Environment |
| 51 | +```commandline |
| 52 | +pip install -r dev_requirements.txt |
| 53 | +``` |
72 | 54 |
|
73 | | -## How to set dev environment |
74 | 55 |
|
75 | | -> * Clone repo on GitHub or download source code |
76 | | -> * Prepare a python venv |
77 | | -> * Run command "pip install --upgrade pip" |
78 | | -> * Run command "pip install -r dev_requirements.txt" |
79 | 56 |
|
80 | | -### Architecture Diagram |
81 | | - |
0 commit comments