Merge pull request #20 from maruel/flags_tools

Add make_tools.py to generate adb.zip and fastboot.zip.

Author: fahhem

.gitignore

@@ -1 +1,3 @@
 *.pyc
+/adb.zip
+/fastboot.zip

README.md

@@ -6,34 +6,52 @@ 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 available at
-https://github.com/android/platform_system_core/tree/master/adb
+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.
+devices and _never_ communicates with a device that it wasn't intended to,
+unlike the Android project's ADB.
+
+
+### Using as standalone tool
+
+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
+
+
+### Pros
 
-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
 
-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:
+
+### Dependencies
+
   * libusb1 (1.0.16+)
   * python-libusb1 (1.2.0+)
-  * python-progressbar (for fastboot_debug, 2.3+)
-  * One of:
+  * `adb.zip`: one of:
     * python-m2crypto (0.21.1+)
     * python-rsa (3.2+)
+  * `fastboot.zip` (optional):
+    * python-progressbar (2.3+)
 
 [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

adb/adb_commands.py

@@ -26,9 +26,9 @@
 import os
 import socket
 
-import adb_protocol
-import common
-import filesync_protocol
+from adb import adb_protocol
+from adb import common
+from adb import filesync_protocol
 
 # From adb.h
 CLASS = 0xFF
@@ -40,7 +40,7 @@
 
 try:
   # Imported locally to keep compatibility with previous code.
-  from sign_m2crypto import M2CryptoSigner
+  from adb.sign_m2crypto import M2CryptoSigner
 except ImportError:
   # Ignore this error when M2Crypto is not installed, there are other options.
   pass

adb/adb_debug.py

@@ -23,15 +23,15 @@
 import sys
 import time
 
-import adb_commands
-import common_cli
+from adb import adb_commands
+from adb import common_cli
 
 try:
-  import sign_m2crypto
+  from adb import sign_m2crypto
   rsa_signer = sign_m2crypto.M2CryptoSigner
 except ImportError:
   try:
-    import sign_pythonrsa
+    from adb import sign_pythonrsa
     rsa_signer = sign_pythonrsa.PythonRSASigner.FromRSAKeyPath
   except ImportError:
     rsa_signer = None

adb/adb_protocol.py

@@ -20,7 +20,7 @@
 import struct
 import time
 
-import usb_exceptions
+from adb import usb_exceptions
 
 
 # Maximum amount of data in an ADB packet.

adb/common.py

@@ -23,7 +23,7 @@
 import libusb1
 import usb1
 
-import usb_exceptions
+from adb import usb_exceptions
 
 DEFAULT_TIMEOUT_MS = 1000
 

adb/common_cli.py

@@ -28,7 +28,7 @@
 import textwrap
 import types
 
-import usb_exceptions
+from adb import usb_exceptions
 
 
 class _PortPathAction(argparse.Action):

adb/fastboot.py

@@ -21,8 +21,8 @@
 import os
 import struct
 
-import common
-import usb_exceptions
+from adb import common
+from adb import usb_exceptions
 
 
 _LOG = logging.getLogger('fastboot')

adb/fastboot_debug.py

@@ -24,10 +24,14 @@
 import logging
 import sys
 
-import progressbar
+from adb import common_cli
+from adb import fastboot
 
-import common_cli
-import fastboot
+try:
+  import progressbar
+except ImportError:
+  # progressbar is optional.
+  progressbar = None
 
 
 def Devices(args):
@@ -100,7 +104,7 @@ def main():
   argspec = inspect.getargspec(args.method)
   if 'info_cb' in argspec.args:
     kwargs['info_cb'] = _InfoCb
-  if 'progress_callback' in argspec.args:
+  if 'progress_callback' in argspec.args and progressbar:
     bar = progressbar.ProgessBar(
         widgets=[progressbar.Bar(), progressbar.Percentage()])
     bar.start()

adb/filesync_protocol.py

@@ -24,8 +24,8 @@
 
 import libusb1
 
-import adb_protocol
-import usb_exceptions
+from adb import adb_protocol
+from adb import usb_exceptions
 
 # Default mode for pushed files.
 DEFAULT_PUSH_MODE = stat.S_IFREG | stat.S_IRWXU | stat.S_IRWXG