ui-finder


Nameui-finder JSON
Version 2.0.1 PyPI version JSON
download
home_pagehttps://github.com/kdiitg/ui_finder
SummaryAndroid UI elements inspector for automating UI testing and development.
upload_time2025-07-09 18:42:26
maintainerNone
docs_urlNone
authorKuldeep Singh
requires_python>=3.7
licenseMIT
keywords android ui inspector automation testing development adb
VCS
bugtrack_url
requirements matplotlib pyperclip Pillow
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 📱 Android UI Inspector

**Android UI Inspector** is a plug-and-play Python-based visual tool to inspect and analyze the UI of Android apps directly from your phone.

🔧 No manual setup needed — it installs `ADB`, `matplotlib`, and `pyperclip` automatically and works across **Windows**, **Linux**, and **macOS**.

---

## 🚀 Features

✅ Auto-installs ADB (platform-tools) for your OS  
✅ Installs Python dependencies automatically  
✅ Connects to real Android devices via USB or Wi-Fi  
✅ Live UI screenshot + hierarchy dump  
✅ Click on UI elements to highlight and inspect them  
✅ Dropdown filter: `class`, `resource-id`, `text`, `bounds`  
✅ One-click **Copy to Clipboard**  
✅ Press `n` to cycle overlapping elements  
✅ Press `r` or click "Refresh Screen" to reload live UI  
✅ Cleans up old screenshots/XML files (older than 10 minutes)  
✅ Cross-platform (Windows, macOS, Linux)  
✅ Works offline after first run

---

## 📲 Requirements

- Android phone with:
  - Developer Mode enabled
  - USB Debugging turned ON
- Python 3.7 or higher
- Internet connection (for first run only)

---

## 🖥 How to Use (All OS)

1. **Clone the repo**
   ```bash
   git clone https://github.com/kdiitg/ui-finder.git
   cd ui_finder
   

2. **In Windows**
   ```
   pip install ui_finder
   In cmd or powershell just type either ui_finder or android_inspector or uif or adr
   ui_finder

3. **In Linux/MacOS**
   ```
   pip3 install ui_finder
   ui_finder

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kdiitg/ui_finder",
    "name": "ui-finder",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "android, ui, inspector, automation, testing, development, adb",
    "author": "Kuldeep Singh",
    "author_email": "kdiitg@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1b/20/658e61936f179ef6484fe77582ffe9bb7260a894a16fee78af4fd28598ba/ui_finder-2.0.1.tar.gz",
    "platform": null,
    "description": "# \ud83d\udcf1 Android UI Inspector\r\n\r\n**Android UI Inspector** is a plug-and-play Python-based visual tool to inspect and analyze the UI of Android apps directly from your phone.\r\n\r\n\ud83d\udd27 No manual setup needed \u2014 it installs `ADB`, `matplotlib`, and `pyperclip` automatically and works across **Windows**, **Linux**, and **macOS**.\r\n\r\n---\r\n\r\n## \ud83d\ude80 Features\r\n\r\n\u2705 Auto-installs ADB (platform-tools) for your OS  \r\n\u2705 Installs Python dependencies automatically  \r\n\u2705 Connects to real Android devices via USB or Wi-Fi  \r\n\u2705 Live UI screenshot + hierarchy dump  \r\n\u2705 Click on UI elements to highlight and inspect them  \r\n\u2705 Dropdown filter: `class`, `resource-id`, `text`, `bounds`  \r\n\u2705 One-click **Copy to Clipboard**  \r\n\u2705 Press `n` to cycle overlapping elements  \r\n\u2705 Press `r` or click \"Refresh Screen\" to reload live UI  \r\n\u2705 Cleans up old screenshots/XML files (older than 10 minutes)  \r\n\u2705 Cross-platform (Windows, macOS, Linux)  \r\n\u2705 Works offline after first run\r\n\r\n---\r\n\r\n## \ud83d\udcf2 Requirements\r\n\r\n- Android phone with:\r\n  - Developer Mode enabled\r\n  - USB Debugging turned ON\r\n- Python 3.7 or higher\r\n- Internet connection (for first run only)\r\n\r\n---\r\n\r\n## \ud83d\udda5 How to Use (All OS)\r\n\r\n1. **Clone the repo**\r\n   ```bash\r\n   git clone https://github.com/kdiitg/ui-finder.git\r\n   cd ui_finder\r\n   \r\n\r\n2. **In Windows**\r\n   ```\r\n   pip install ui_finder\r\n   In cmd or powershell just type either ui_finder or android_inspector or uif or adr\r\n   ui_finder\r\n\r\n3. **In Linux/MacOS**\r\n   ```\r\n   pip3 install ui_finder\r\n   ui_finder\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Android UI elements inspector for automating UI testing and development.",
    "version": "2.0.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/kdiitg/{module_name}/issues",
        "Documentation": "https://github.com/kdiitg/{module_name}",
        "Homepage": "https://github.com/kdiitg/ui_finder",
        "Source": "https://github.com/kdiitg/{module_name}"
    },
    "split_keywords": [
        "android",
        " ui",
        " inspector",
        " automation",
        " testing",
        " development",
        " adb"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ffbeed8ff5e88d98b7780c0eeaaa6662ce364753e27d8dabf646250fb37a93a6",
                "md5": "94f793f33e8ea5f0c1dfa3e82dc9c688",
                "sha256": "a6b77c35b8522620b2494a2dc507205d724623bd4cb88efbfbf823dd1d4424b8"
            },
            "downloads": -1,
            "filename": "ui_finder-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "94f793f33e8ea5f0c1dfa3e82dc9c688",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 16939,
            "upload_time": "2025-07-09T18:42:25",
            "upload_time_iso_8601": "2025-07-09T18:42:25.382709Z",
            "url": "https://files.pythonhosted.org/packages/ff/be/ed8ff5e88d98b7780c0eeaaa6662ce364753e27d8dabf646250fb37a93a6/ui_finder-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1b20658e61936f179ef6484fe77582ffe9bb7260a894a16fee78af4fd28598ba",
                "md5": "d0f6c5d232f32da0ae469cb913176c14",
                "sha256": "755a9003f02fae7212f57eea631287fa9ceabf18c39752ef0f63fef990d5565e"
            },
            "downloads": -1,
            "filename": "ui_finder-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d0f6c5d232f32da0ae469cb913176c14",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 12050,
            "upload_time": "2025-07-09T18:42:26",
            "upload_time_iso_8601": "2025-07-09T18:42:26.772316Z",
            "url": "https://files.pythonhosted.org/packages/1b/20/658e61936f179ef6484fe77582ffe9bb7260a894a16fee78af4fd28598ba/ui_finder-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 18:42:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kdiitg",
    "github_project": "ui_finder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.5"
                ],
                [
                    "<",
                    "4.0"
                ]
            ]
        },
        {
            "name": "pyperclip",
            "specs": [
                [
                    ">=",
                    "1.8"
                ],
                [
                    "<",
                    "2.0"
                ]
            ]
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    "<",
                    "12.0"
                ],
                [
                    ">=",
                    "9.0"
                ]
            ]
        }
    ],
    "lcname": "ui-finder"
}
        
Elapsed time: 0.62441s