# easy-adb
## Introduction
easy-adb is a tool written in Python that simplifies the use of Android Debug Bridge (ADB) commands.
With this tool, you can easily perform tasks such as starting an ADB server, connecting to an Android device, and executing ADB commands using Python code.
Important : This project does not contain any content from the Android SDK Platform-Tools.
Necessary libraries must be downloaded separately by the download_adb_binary command.
## Installation
If Python >= 3.9 is installed, you can install easy-adb with the following command:
```shell
pip install easy-adb
```
## Usage
easy-adb can be used through a command-line interface (CLI).
Here is the basic way to use easy-adb:
```shell
python -m easy_adb.cli --ip [device IP] --port [port number] --adb-command [ADB command to execute]
```
replace [device IP], [port number], and [ADB command to execute] with the actual values.
or you can use easy-adb in Python code:
```python
from easy_adb import run_adb_server, set_signer, connect_device, send_command, download_adb_binary
# equivalent to: easy-adb --ip 192.168.0.1 --port=5555 --adb-command="getprop ro.product.model"
# download_adb_binary() # optional
run_adb_server()
test_device = connect_device(set_signer(), "192.168.0.1", 5555)
result = send_command(test_device, "getprop ro.product.model")
```
## Features
easy-adb provides the following features:
* ADB Server Management: Start the ADB server from Python code.
* Device Connection Management: Connect to Android devices using WI-FI IP address and port number.
* ADB Command Execution: Execute ADB command and retrieve output.
## License
This project is distributed under the LGPLv3 license. See the [LICENSE](LICENSE) file for details.
## Disclaimer
Please note that the easy-adb library does not take any responsibility for the download and use of the Android SDK Platform-Tools.
Users are responsible for ensuring that they download and use these tools in a manner that is in compliance with the terms and conditions set forth by the original provider.
## Contact
For bug reports about this project, please submit them through the GitHub issue tracker.
Raw data
{
"_id": null,
"home_page": "https://github.com/minwook-shin/easy-adb",
"name": "easy-adb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "python,adb,android",
"author": "minwook-shin",
"author_email": "minwook0106@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/23/f6/bd97d556f49e9c62c6856ef7da02b9de77175d8e2c1b2adc44400177c00c/easy-adb-0.1.1.tar.gz",
"platform": null,
"description": "# easy-adb\n\n## Introduction\n\neasy-adb is a tool written in Python that simplifies the use of Android Debug Bridge (ADB) commands. \n\nWith this tool, you can easily perform tasks such as starting an ADB server, connecting to an Android device, and executing ADB commands using Python code.\n\nImportant : This project does not contain any content from the Android SDK Platform-Tools. \nNecessary libraries must be downloaded separately by the download_adb_binary command.\n\n## Installation\n\nIf Python >= 3.9 is installed, you can install easy-adb with the following command:\n\n```shell\npip install easy-adb\n```\n\n## Usage\n\neasy-adb can be used through a command-line interface (CLI). \n\nHere is the basic way to use easy-adb:\n\n```shell\npython -m easy_adb.cli --ip [device IP] --port [port number] --adb-command [ADB command to execute]\n```\n\nreplace [device IP], [port number], and [ADB command to execute] with the actual values.\n\nor you can use easy-adb in Python code:\n\n```python\nfrom easy_adb import run_adb_server, set_signer, connect_device, send_command, download_adb_binary\n\n# equivalent to: easy-adb --ip 192.168.0.1 --port=5555 --adb-command=\"getprop ro.product.model\"\n\n# download_adb_binary() # optional\nrun_adb_server()\ntest_device = connect_device(set_signer(), \"192.168.0.1\", 5555)\nresult = send_command(test_device, \"getprop ro.product.model\")\n```\n\n## Features\n\neasy-adb provides the following features:\n\n* ADB Server Management: Start the ADB server from Python code.\n* Device Connection Management: Connect to Android devices using WI-FI IP address and port number.\n* ADB Command Execution: Execute ADB command and retrieve output.\n\n## License\n\nThis project is distributed under the LGPLv3 license. See the [LICENSE](LICENSE) file for details.\n\n## Disclaimer\n\nPlease note that the easy-adb library does not take any responsibility for the download and use of the Android SDK Platform-Tools. \n\nUsers are responsible for ensuring that they download and use these tools in a manner that is in compliance with the terms and conditions set forth by the original provider. \n\n## Contact\n\nFor bug reports about this project, please submit them through the GitHub issue tracker.\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Easy to use ADB commands in Python 3",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://github.com/minwook-shin/easy-adb/issues",
"Homepage": "https://github.com/minwook-shin/easy-adb"
},
"split_keywords": [
"python",
"adb",
"android"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48d0794f33b05fac200dcd6f1c097373fbeb2c8305a2d49197a5fff562b6683b",
"md5": "7746daf9d9974ba4c912c8beb1e4eaac",
"sha256": "8f8a912fd1e86e7bbad0f709956b0ea5b869061c64cb9bcce5df19b99fd6bc17"
},
"downloads": -1,
"filename": "easy_adb-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7746daf9d9974ba4c912c8beb1e4eaac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14729,
"upload_time": "2024-03-05T07:10:15",
"upload_time_iso_8601": "2024-03-05T07:10:15.614131Z",
"url": "https://files.pythonhosted.org/packages/48/d0/794f33b05fac200dcd6f1c097373fbeb2c8305a2d49197a5fff562b6683b/easy_adb-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23f6bd97d556f49e9c62c6856ef7da02b9de77175d8e2c1b2adc44400177c00c",
"md5": "79e89f7b9fa3c2eccc6247bc29d6f76c",
"sha256": "d1f07962364ca3075f92d7d0cb59c37c24b0391fcaa46ca737c718c3986b38e1"
},
"downloads": -1,
"filename": "easy-adb-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "79e89f7b9fa3c2eccc6247bc29d6f76c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14108,
"upload_time": "2024-03-05T07:10:17",
"upload_time_iso_8601": "2024-03-05T07:10:17.279460Z",
"url": "https://files.pythonhosted.org/packages/23/f6/bd97d556f49e9c62c6856ef7da02b9de77175d8e2c1b2adc44400177c00c/easy-adb-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 07:10:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "minwook-shin",
"github_project": "easy-adb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "adb-shell",
"specs": [
[
"==",
"0.4.4"
]
]
}
],
"lcname": "easy-adb"
}
JSON
