cdlaimin · pull · Feb 24, 2024 · Feb 24, 2024 · Feb 24, 2024 · Feb 24, 2024
diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -2,25 +2,27 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
+    types: [published,created] # Triggers the workflow when a release is published
 
 jobs:
-  deploy:
+  build-and-publish:
     runs-on: ubuntu-latest
+    environment:
+      name: release # Must match the environment name configured on PyPI (if used)
+    permissions:
+      contents: read
+      id-token: write # Mandatory for OIDC trusted publishing
+
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.x'
+        python-version: "3.x"
     - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        python setup.py clean sdist bdist_wheel
-        twine upload dist/*
+      run: python -m pip install --upgrade pip build
+    - name: Build package
+      run: python -m build
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      # No username or password needed; OIDC handles authentication
diff --git a/.gitignore b/.gitignore
@@ -27,4 +27,8 @@ tmp/
 
 # venv #
 ########
-venv/*
+venv*/*
+
+# Kiro #
+########
+.kiro/
diff --git a/README.md b/README.md
@@ -1,19 +1,18 @@
 AndroidViewClient
 =================
 <a href="#"><img src="https://github.com/dtmilano/AndroidViewClient/wiki/images/culebra-logo-transparent-204x209-rb-border.png" align="left" hspace="0" vspace="6"></a>
-**AndroidViewClient** was originally conceived as an extension to [monkeyrunner](http://developer.android.com/tools/help/monkeyrunner_concepts.html) but lately evolved
-as a pure python tool that automates or simplifies test script creation.
-It is a test framework for Android applications that:
+**AndroidViewClient/culebra** was initially conceived as an extension to [monkeyrunner](http://developer.android.com/tools/help/monkeyrunner_concepts.html)  but has since evolved
+into a versatile pure Python tool.
+It streamlines test script creation for Android applications by automating tasks and simplifying interactions. This test framework:
 <ul><ul>
-    <li>Automates driving Android applications</li>
-    <li>Generates re-usable scripts</li>
-    <li>Provides view-based <i>device independent</i> UI interaction</li>
-    <li>Uses 'logical' screen comparison (UI Automator Hierarchy based) over image comparison (Avoiding extraneous 
-    detail issues, such as time or data changes)</li>
-    <li>Supports running concurrently on multiple devices</li>
-    <li>Provides simple control for high level operations like language change and activity start</li>
-    <li>Supports all Android APIs</li>
-    <li>Is written in python (python 3.6+ support in 20.x.y+)</li>
+  <li>Automates the navigation of Android applications.</li>
+  <li>Generates reusable scripts for efficient testing.</li>
+  <li>Offers device-independent UI interaction based on views.</li>
+  <li>Utilizes 'logical' screen comparison (UI Automator Hierarchy based) instead of image comparison, avoiding extraneous detail issues like time or data changes.</li>
+  <li>Supports concurrent operation on multiple devices.</li>
+  <li>Provides straightforward control for high-level operations such as language change and activity start.</li>
+  <li>Fully supports all Android APIs.</li>
+  <li>Written in Python with support for Python 3.6 and above in versions 20.x.y and beyond.</li>
 </ul></ul>
 
 **🛎** |A new Kotlin backend is under development to provide more functionality and improve performance.<br>Take a look at [CulebraTester2](https://github.com/dtmilano/CulebraTester2-public) and 20.x.y-series prerelease. |
@@ -26,9 +25,11 @@ It is a test framework for Android applications that:
 
 **NOTE**: Pypi statistics are broken see [here](https://github.com/aclark4life/vanity/issues/22). The new statistics can be obtained from [BigQuery](https://bigquery.cloud.google.com/queries/culebra-tester).
 
-As of August 2021 we have reached:
+As of February 2024 we have reached:
 
-<img src="https://github.com/dtmilano/AndroidViewClient/wiki/images/androidviewclient-culebra-1million.png" alt="culebra 1 million downloads" width="80%" align="center">
+<p align="center">
+  <img src="https://github.com/dtmilano/AndroidViewClient/wiki/images/androidviewclient-culebra-2-million-downloads.png" alt="culebra 2 million downloads" width="80%" align="center">
+</p>
 
 Thanks to all who made it possible.
 
@@ -38,6 +39,81 @@ pip3 install androidviewclient --upgrade
 ```
 Or check the wiki for more alternatives.
 
+# AI-Powered Testing with MCP
+
+**NEW!** AndroidViewClient now includes a Model Context Protocol (MCP) server that enables AI assistants like Kiro to interact with Android devices through natural language.
+
+## Quick Start with MCP
+
+1. **Install with MCP support:**
+   ```bash
+   pip3 install androidviewclient --upgrade
+   ```
+
+2. **Start CulebraTester2 on your device:**
+
+   Check the details at [How to run CulebraTester2 ?](https://github.com/dtmilano/CulebraTester2-public?tab=readme-ov-file#how-to-run-culebratester2-)
+
+
+4. **Configure your AI assistant:**
+
+   Add to `.kiro/settings/mcp.json` or `~/.kiro/settings/mcp.json`:
+   ```json
+   {
+     "mcpServers": {
+       "culebratester2": {
+         "command": "culebra-mcp",
+         "env": {
+           "CULEBRATESTER2_URL": "http://localhost:9987"
+         }
+       }
+     }
+   }
+   ```
+
+5. **Start testing with natural language:**
+   - "_Get the device screen size_"
+   - "_Launch the Calculator app_"
+   - "_Find the button with text Submit and click it_"
+   - "_Take a screenshot_"
+   - "_Swipe up to scroll_"
+
+## MCP Tools Available
+
+The MCP server provides 20 tools for Android automation:
+
+**Element-based interactions:**
+- Find elements by text or resource ID
+- Click, long-click, enter text, clear text
+- Navigate with back/home buttons
+- Launch applications
+
+**Coordinate-based interactions:**
+- Click/long-click at coordinates
+- Swipe gestures
+
+**Device actions:**
+- Wake/sleep device
+- Get current app
+- Force stop apps
+- Take screenshots
+
+## Configuration
+
+For detailed MCP configuration options, see the [MCP Configuration Guide](docs/MCP_CONFIGURATION.md).
+
+Quick reference:
+- **User-level config** (kiro-cli): `~/.kiro/settings/mcp.json`
+- **Workspace config** (Kiro IDE): `.kiro/settings/mcp.json`
+- **Examples:** `examples/mcp_config.json`
+- **Usage examples:** `examples/test_calculator_mcp.py`
+
+## Environment Variables
+
+- `CULEBRATESTER2_URL`: Base URL for CulebraTester2 (default: `http://localhost:9987`)
+- `CULEBRATESTER2_TIMEOUT`: HTTP timeout in seconds (default: `30`)
+- `CULEBRATESTER2_DEBUG`: Enable debug logging (`1`, `true`, or `yes`)
+
 # Want to learn more?
 
 > 🚀 Check [Examples](https://github.com/dtmilano/AndroidViewClient/wiki/Resources#examples) and [Screencasts and videos](https://github.com/dtmilano/AndroidViewClient/wiki/Resources#screencasts-and-videos) page to see it in action.