airtest-mobileauto

Name	airtest-mobileauto JSON
Version	2.1.3 JSON
	download
home_page	https://github.com/cndaqiang/airtest_mobileauto
Summary	A robust, object-oriented, multi-process mobile app control framework based on AirTest, designed for stable and compatible debugging and automation of devices and apps. Ideal for tasks such as game automation in titles like Honor of Kings, with enhanced stability features including connection checks, automatic retries on failure, and automatic restarts for continuous operation.
upload_time	2024-12-14 03:30:20
maintainer	None
docs_url	None
author	cndaqiang
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	airtest numpy pyyaml
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # AirTest Mobile Automation

AirTest Mobile Automation is an object-oriented, multi-process control framework for mobile apps based on the AirTest framework. It is designed for stability and compatibility, making it ideal for automating tasks in games like Honor of Kings.

## Features

* **Enhanced Stability**: This framework enhances the reliability of testing and automation by implementing rigorous connection status checks and intelligent automatic reconnection mechanisms. Instead of throwing errors upon failure, it encapsulates AirTest functions to attempt reconnections, ensuring continuous operation even in the face of transient network issues or screenshot retrieval failures. In rare cases, such as with iOS devices, it may prompt for a physical reconnect of the device to be recognized by `tidevice list`. Additionally, it addresses and corrects issues with the `start_app` function that could occur on certain Android systems, providing a smoother and more resilient automation experience.
* **Automated Operation**: Capable of fully automated processes with unattended operation. In case of errors, it automatically restarts the app or the control endpoint, such as Docker or an Android emulator.
* **Time Management**: Utilizes the UTC/GMT+08:00 time zone for task scheduling aligned with Chinese game refresh cycles.
* **Formatted Output**: Displays information in a formatted manner, e.g.,  `[MM-DD HH:MM:SS] info`.

## Modules

### Device Management ( `deviceOB` )

Handles device management in an object-oriented approach, supporting various clients and control endpoints.

| Clients | Control Endpoints | Management Capabilities |
|---------|-------------------|-------------------------|
| [BlueStacks](https://www.bluestacks.com/download.html) / [LDPlayer](https://www.ldplayer.net/)/ [MuMu](https://mumu.163.com/) | Windows | Start, stop, and restart emulators |
| [Docker](https://hub.docker.com/r/redroid/redroid) | Linux | Start, stop, and restart containers |
| iOS | Mac | Reconnect with tidevice, restart iOS |
| USB-connected Android phones | ALL | Reboot Android system |
| WIFI-connected phones | ALL | Hot reboot Android system |

### APP Management ( `appOB` )

Manages the opening, stopping, and restarting of apps.

### Tools ( `DQWheel` )

* A utility for multi-process support based on the file system, including synchronization, broadcasting, file management, and enhanced time management.
* Utilizes files and dictionaries to store and retrieve image coordinates, reducing the time to locate element coordinates repeatedly. It also allows for selecting specific positions, such as the least proficient hero in Honor of Kings based on proficiency.

## Development Examples

Below are some examples of development scripts that demonstrate the capabilities of the project.

- An automation script for [Honor of Kings](https://github.com/cndaqiang/WZRY) .
- Automate daily sign-ins and claim gift packages on Android with [AutoAnSign](https://github.com/MobileAutoFlow/AutoAnSign).

For the configuration file format, see [this guide](https://wzry-doc.pages.dev/guide/config/).

## Acknowledgements

The historical versions of this script, namely [WZRY_AirtestIDE_XiaoMi11@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_XiaoMi11), [WZRY_AirtestIDE_emulator@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_emulator), and [WZRY@cndaqiang](https://github.com/cndaqiang/WZRY) have also been instrumental in the development process.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Copyright

&copy; 2024 cndaqiang. All rights reserved.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cndaqiang/airtest_mobileauto",
    "name": "airtest-mobileauto",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "cndaqiang",
    "author_email": "who@cndaqiang.ac.cn",
    "download_url": "https://files.pythonhosted.org/packages/16/2c/7bfb8318ef4e6706bb80b5ef843697a3de771d709c7cf91b0ea9489c1a21/airtest_mobileauto-2.1.3.tar.gz",
    "platform": null,
    "description": "# AirTest Mobile Automation\r\n\r\nAirTest Mobile Automation is an object-oriented, multi-process control framework for mobile apps based on the AirTest framework. It is designed for stability and compatibility, making it ideal for automating tasks in games like Honor of Kings.\r\n\r\n## Features\r\n\r\n* **Enhanced Stability**: This framework enhances the reliability of testing and automation by implementing rigorous connection status checks and intelligent automatic reconnection mechanisms. Instead of throwing errors upon failure, it encapsulates AirTest functions to attempt reconnections, ensuring continuous operation even in the face of transient network issues or screenshot retrieval failures. In rare cases, such as with iOS devices, it may prompt for a physical reconnect of the device to be recognized by `tidevice list`. Additionally, it addresses and corrects issues with the `start_app` function that could occur on certain Android systems, providing a smoother and more resilient automation experience.\r\n* **Automated Operation**: Capable of fully automated processes with unattended operation. In case of errors, it automatically restarts the app or the control endpoint, such as Docker or an Android emulator.\r\n* **Time Management**: Utilizes the UTC/GMT+08:00 time zone for task scheduling aligned with Chinese game refresh cycles.\r\n* **Formatted Output**: Displays information in a formatted manner, e.g.,  `[MM-DD HH:MM:SS] info`.\r\n\r\n## Modules\r\n\r\n### Device Management ( `deviceOB` )\r\n\r\nHandles device management in an object-oriented approach, supporting various clients and control endpoints.\r\n\r\n| Clients | Control Endpoints | Management Capabilities |\r\n|---------|-------------------|-------------------------|\r\n| [BlueStacks](https://www.bluestacks.com/download.html) / [LDPlayer](https://www.ldplayer.net/)/ [MuMu](https://mumu.163.com/) | Windows | Start, stop, and restart emulators |\r\n| [Docker](https://hub.docker.com/r/redroid/redroid) | Linux | Start, stop, and restart containers |\r\n| iOS | Mac | Reconnect with tidevice, restart iOS |\r\n| USB-connected Android phones | ALL | Reboot Android system |\r\n| WIFI-connected phones | ALL | Hot reboot Android system |\r\n\r\n### APP Management ( `appOB` )\r\n\r\nManages the opening, stopping, and restarting of apps.\r\n\r\n### Tools ( `DQWheel` )\r\n\r\n* A utility for multi-process support based on the file system, including synchronization, broadcasting, file management, and enhanced time management.\r\n* Utilizes files and dictionaries to store and retrieve image coordinates, reducing the time to locate element coordinates repeatedly. It also allows for selecting specific positions, such as the least proficient hero in Honor of Kings based on proficiency.\r\n\r\n## Development Examples\r\n\r\nBelow are some examples of development scripts that demonstrate the capabilities of the project.\r\n\r\n- An automation script for [Honor of Kings](https://github.com/cndaqiang/WZRY) .\r\n- Automate daily sign-ins and claim gift packages on Android with [AutoAnSign](https://github.com/MobileAutoFlow/AutoAnSign).\r\n\r\nFor the configuration file format, see [this guide](https://wzry-doc.pages.dev/guide/config/).\r\n\r\n## Acknowledgements\r\n\r\nThe historical versions of this script, namely [WZRY_AirtestIDE_XiaoMi11@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_XiaoMi11), [WZRY_AirtestIDE_emulator@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_emulator), and [WZRY@cndaqiang](https://github.com/cndaqiang/WZRY) have also been instrumental in the development process.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Copyright\r\n\r\n&copy; 2024 cndaqiang. All rights reserved.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A robust, object-oriented, multi-process mobile app control framework based on AirTest, designed for stable and compatible debugging and automation of devices and apps. Ideal for tasks such as game automation in titles like Honor of Kings, with enhanced stability features including connection checks, automatic retries on failure, and automatic restarts for continuous operation.",
    "version": "2.1.3",
    "project_urls": {
        "Homepage": "https://github.com/cndaqiang/airtest_mobileauto"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "162c7bfb8318ef4e6706bb80b5ef843697a3de771d709c7cf91b0ea9489c1a21",
                "md5": "2efd2efc8a30df7eedbc2a93d983c233",
                "sha256": "b8633c75e60827891e0868c1264d37a3b6951bfa6400a131b674db52911f13bb"
            },
            "downloads": -1,
            "filename": "airtest_mobileauto-2.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2efd2efc8a30df7eedbc2a93d983c233",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 29918,
            "upload_time": "2024-12-14T03:30:20",
            "upload_time_iso_8601": "2024-12-14T03:30:20.390635Z",
            "url": "https://files.pythonhosted.org/packages/16/2c/7bfb8318ef4e6706bb80b5ef843697a3de771d709c7cf91b0ea9489c1a21/airtest_mobileauto-2.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-14 03:30:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cndaqiang",
    "github_project": "airtest_mobileauto",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "airtest",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "pyyaml",
            "specs": []
        }
    ],
    "lcname": "airtest-mobileauto"
}

cndaqiang