README.md
1 <!-- Copyright 2015 The Chromium Authors. All rights reserved.
2 Use of this source code is governed by a BSD-style license that can be
3 found in the LICENSE file.
4 -->
5 ## devil
6
7
8
9 devil is a library used by the Chromium developers to interact with Android
10 devices. It currently supports SDK level 16 and above.
11
12 ## Interfaces
13
14 devil provides python APIs:
15 - [`devil.android.adb_wrapper`](docs/adb_wrapper.md) provides a thin wrapper
16 around the adb binary. Most functions and methods have direct analogues on
17 the adb command-line.
18 - [`devil.android.device_utils`](docs/device_utils.md) provides higher-level
19 functionality built on top of `adb_wrapper`. **This is the primary
20 mechanism through which chromium's scripts interact with devices.**
21
22 ## Utilities
23
24 devil also provides command-line utilities:
25 - [`devil/utils/markdown.py`](docs/markdown.md) generated markdown
26 documentation for python modules.
27
28 ## Constraints and Caveats
29
30 devil is used with python 2.7. Its compatibility with python 3 has not been
31 tested, and neither achieving nor maintaining said compatibility is currently
32 a priority.
33
34 ## Contributing
35
36 Please see the [contributor's guide](https://github.com/catapult-project/catapult/blob/master/CONTRIBUTING.md).
37
38