This repository has been archived on 2023-03-16. You can view files and clone it, but cannot push or open issues or pull requests.
Android-Mobile-Toolkit/platform-tools/systrace/catapult/devil/README.md
2019-09-27 23:56:01 -04:00

38 lines
1.3 KiB
Markdown

<!-- 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 (device interaction layer) 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).