python-adb

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

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:

pip install adb

Once installed, two new binaries should be available: pyadb and pyfastboot.

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, and here's some demo code:

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:

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)

g1im2 / python-adb