Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google/python-adb
Python ADB + Fastboot implementation
https://github.com/google/python-adb
Last synced: about 1 month ago
JSON representation
Python ADB + Fastboot implementation
- Host: GitHub
- URL: https://github.com/google/python-adb
- Owner: google
- License: apache-2.0
- Archived: true
- Created: 2014-07-01T23:00:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T19:01:19.000Z (7 months ago)
- Last Synced: 2024-09-20T22:01:58.378Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 179 KB
- Stars: 1,793
- Watchers: 110
- Forks: 357
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rainmana - google/python-adb - Python ADB + Fastboot implementation (Python)
- awesome-hacking-lists - google/python-adb - Python ADB + Fastboot implementation (Python)
README
python-adb
==========
[![Coverage Status][coverage_img]][coverage_link]
[![Build Status][build_img]][build_link]
Note: This is not an official Google project. It is maintained by ex-Google engineers. For a better maintained option, look at [adb_shell](https://github.com/JeffLIrion/adb_shell).
This repository contains a pure-python implementation of the ADB and Fastboot
protocols, using libusb1 for USB communications.
This is a complete replacement and rearchitecture of the Android project's [ADB
and fastboot code](https://github.com/android/platform_system_core/tree/master/adb)
This code is mainly targeted to users that need to communicate with Android
devices in an automated fashion, such as in automated testing. It does not have
a daemon between the client and the device, and therefore does not support
multiple simultaneous commands to the same device. It does support any number of
devices and _never_ communicates with a device that it wasn't intended to,
unlike the Android project's ADB.
### Using as standalone tool
Install using pip:
```sh
pip install adb
```
Once installed, two new binaries should be available: `pyadb` and `pyfastboot`.
```sh
pyadb devices
pyadb shell ls /sdcard
```
Running `./make_tools.py` creates two files: `adb.zip` and `fastboot.zip`. They
can be run similar to native `adb` and `fastboot` via the python interpreter:
python adb.zip devices
python adb.zip shell ls /sdcard
### Using as a Python Library
A [presentation was made at PyCon 2016][pycon_preso], and here's some demo code:
```python
import os.path as op
from adb import adb_commands
from adb import sign_cryptography
# KitKat+ devices require authentication
signer = sign_cryptography.CryptographySigner(
op.expanduser('~/.android/adbkey'))
# Connect to the device
device = adb_commands.AdbCommands()
device.ConnectDevice(
rsa_keys=[signer])
# Now we can use Shell, Pull, Push, etc!
for i in xrange(10):
print device.Shell('echo %d' % i)
```
### Pros
* Simpler code due to use of libusb1 and Python.
* API can be used by other Python code easily.
* Errors are propagated with tracebacks, helping debug connectivity issues.
* No daemon outliving the command.
* Can be packaged as standalone zips that can be run independent of the CPU
architecture (e.g. x86 vs ARM).
### Cons
* Technically slower due to Python, mitigated by no daemon.
* Only one command per device at a time.
* More dependencies than Android's ADB.
### Dependencies
* libusb1 (1.0.16+)
* python-libusb1 (1.2.0+)
* `adb.zip`: one of:
* py-cryptography
* python-rsa (3.2+)
* `fastboot.zip` (optional):
* python-progressbar (2.3+)
### History
#### 1.0.0
* Initial version
#### 1.1.0
* Added TcpHandle (jameyhicks)
* Various timing and other changes (alusco)
#### 1.2.0
* Update to libusb1 1.6+ (bytearray output)
* Add support for Python 3.6
* Create adb.zip and fastboot.zip as executable tools.
* Add Travis CI integration
* Support multiple crypto libraries (M2Crypto + python-rsa)
* Push directories
#### 1.3.0
##### Backwards Incompatible changes
`adb_commands.AdbCommands()` is now a normal class rather than a collection of staticmethods. Using the following example code to get started:
```py
device = adb_commands.AdbCommands()
device.ConnectDevice(rsa_keys=[signer])
```
##### Other changes/fixes
Many changes since 1.2.0!
* New entrypoints exposed by pip: pyadb and pyfastboot
* Lots of Python 2/3 compatibility fixes
* Windows compatibility fixes
* Transfer progress available (`Push`, `Pull`, `Install`)
* Handle some misbehaving devices (double CLSE bug)
* New options for `Push` and `Install` (`st_mode` and `grant_permissions`)
[coverage_img]: https://coveralls.io/repos/github/google/python-adb/badge.svg?branch=master
[coverage_link]: https://coveralls.io/github/google/python-adb?branch=master
[build_img]: https://travis-ci.org/google/python-adb.svg?branch=master
[build_link]: https://travis-ci.org/google/python-adb
[pycon_preso]: https://docs.google.com/presentation/d/1bv8pmm8TZp4aFxoq2ohA-ms_a3BWci7D3tYvVGIm8T0/pub?start=false&loop=false&delayms=10000