diff options
author | Chris Craik <ccraik@google.com> | 2017-04-03 15:54:29 -0700 |
---|---|---|
committer | Chris Craik <ccraik@google.com> | 2017-04-03 16:02:14 -0700 |
commit | c088b23ae5d8cab6878e43cc37b7b5d141f6c6d7 (patch) | |
tree | df2eac86f23cb2dab056b1972c16a6222e005a89 /catapult/devil/README.md | |
parent | b6ff195e4c30012fa6a7b3fe13a7938dc1c007ea (diff) | |
parent | 9ede47ea07acc34a4fe73d2ef5ba128fe1511483 (diff) | |
download | chromium-trace-c088b23ae5d8cab6878e43cc37b7b5d141f6c6d7.tar.gz |
resolve merge conflicts of 9ede47ea to oc-dev-plus-aosp
Test: external/chromium-trace/systrace.py
Change-Id: I06f10b563d774ebcd6ebee75eb3622d0d71795c2
Diffstat (limited to 'catapult/devil/README.md')
-rw-r--r-- | catapult/devil/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/catapult/devil/README.md b/catapult/devil/README.md new file mode 100644 index 00000000..852ac378 --- /dev/null +++ b/catapult/devil/README.md @@ -0,0 +1,37 @@ +<!-- Copyright 2015 The Chromium Authors. All rights reserved. + Use of this source code is governed by a BSD-style license that can be + found in the LICENSE file. +--> +## devil + +😈 + +devil is a library used by the Chromium developers to interact with Android +devices. It currently supports SDK level 16 and above. + +## Interfaces + +devil provides python APIs: + - [`devil.android.adb_wrapper`](docs/adb_wrapper.md) provides a thin wrapper + around the adb binary. Most functions and methods have direct analogues on + the adb command-line. + - [`devil.android.device_utils`](docs/device_utils.md) provides higher-level + functionality built on top of `adb_wrapper`. **This is the primary + mechanism through which chromium's scripts interact with devices.** + +## Utilities + +devil also provides command-line utilities: + - [`devil/utils/markdown.py`](docs/markdown.md) generated markdown + documentation for python modules. + +## Constraints and Caveats + +devil is used with python 2.7. Its compatibility with python 3 has not been +tested, and neither achieving nor maintaining said compatibility is currently +a priority. + +## Contributing + +Please see the [contributor's guide](https://github.com/catapult-project/catapult/blob/master/CONTRIBUTING.md). + |