Skip to main content

Android automation toolkit with screenshot grounding, ADB actions, and Airtest helpers for AI-authored scripts.

Project description

droid-use

droid-use is a Python package for Android UI automation driven by screenshots, grounding, and ADB.

It focuses on two related workflows:

  • Direct Android device control through ADB helpers such as screenshot capture, tap, long press, swipe, text input, and key events.
  • Screenshot grounding that turns a natural-language instruction plus a phone screenshot into a concrete device action or bounding box, with visual overlays and evaluator feedback loops.

It also includes Airtest-oriented utilities so an AI agent can help write or refine Android automation scripts that rely on visual matching and OCR.

Main capabilities

  • ADB-backed Android interaction helpers
  • Screenshot-based coordinate grounding for taps, long presses, swipes, and bbox selection
  • Coordinate conversion helpers for pixel and normalized coordinate systems
  • Grounding orchestration with operator/evaluator loops and artifact logging
  • Airtest helper utilities for AI-authored automation scripts

Installation

pip install droid-use

For local development:

pip install -e .

Example

from droid_use import get_screenshot, interact_with_screen

get_screenshot("/tmp/screen.png")
result = interact_with_screen(
    "/tmp/screen.png",
    "点击底部中间的登录按钮",
    max_rounds=3,
)

print(result)

Airtest-oriented usage

The package also ships helper modules under droid_use.airtest_utils for workflows where an AI agent writes or edits Airtest-style Android automation scripts.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

droid_use-0.1.0.tar.gz (62.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

droid_use-0.1.0-py3-none-any.whl (61.8 kB view details)

Uploaded Python 3

File details

Details for the file droid_use-0.1.0.tar.gz.

File metadata

  • Download URL: droid_use-0.1.0.tar.gz
  • Upload date:
  • Size: 62.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for droid_use-0.1.0.tar.gz
Algorithm Hash digest
SHA256 628932a8f5f8f7ec0765deb6280969e97a87704bd62ddc3401dfab179deca828
MD5 19de18a52ab2f001fe1b366764b5d270
BLAKE2b-256 828e089816a1b76c2d6a393542ab4f60145632c1c49fccbe3d17d463284b6b22

See more details on using hashes here.

File details

Details for the file droid_use-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: droid_use-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 61.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for droid_use-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4bf63eec6802edd93706fd5fe4aed9fd403365b9c146b95493fd4eda81818e9
MD5 503bb90bdf45c4189fc2116f78009241
BLAKE2b-256 4b7f3d93c1d3e824c3a37894d2435e32edadaf36ee7b0854684aae2b44f77e6d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page