droidrun 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

droidrun-0.2.0.dist-info/METADATA

@@ -1,373 +0,0 @@
-Metadata-Version: 2.4
-Name: droidrun
-Version: 0.2.0
-Summary: A framework for controlling Android devices through LLM agents
-Project-URL: Homepage, https://github.com/droidrun/droidrun
-Project-URL: Bug Tracker, https://github.com/droidrun/droidrun/issues
-Project-URL: Documentation, https://docs.droidrun.ai/
-Author-email: Niels Schmidt <niels.schmidt@droidrun.ai>
-License: MIT
-License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Communications :: Chat
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Quality Assurance
-Classifier: Topic :: Software Development :: Testing
-Classifier: Topic :: Software Development :: Testing :: Acceptance
-Classifier: Topic :: System :: Emulators
-Classifier: Topic :: Utilities
-Requires-Python: >=3.10
-Requires-Dist: aiofiles>=23.0.0
-Requires-Dist: anthropic>=0.7.0
-Requires-Dist: arize-phoenix
-Requires-Dist: click>=8.1.0
-Requires-Dist: llama-index
-Requires-Dist: llama-index-callbacks-arize-phoenix
-Requires-Dist: llama-index-llms-anthropic
-Requires-Dist: llama-index-llms-deepseek
-Requires-Dist: llama-index-llms-gemini
-Requires-Dist: llama-index-llms-ollama
-Requires-Dist: llama-index-llms-openai
-Requires-Dist: openai>=1.0.0
-Requires-Dist: pillow>=10.0.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: python-dotenv>=1.0.0
-Requires-Dist: rich>=13.0.0
-Provides-Extra: dev
-Requires-Dist: black>=23.0.0; extra == 'dev'
-Requires-Dist: mypy>=1.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.1.0; extra == 'dev'
-Description-Content-Type: text/markdown
-
-
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="./static/droidrun-dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="./static/droidrun.png">
-  <img src="./static/droidrun.png"  width="full">
-</picture>
-
-[![GitHub stars](https://img.shields.io/github/stars/droidrun/droidrun?style=social)](https://github.com/droidrun/droidrun/stargazers)
-[![Discord](https://img.shields.io/discord/1360219330318696488?color=7289DA&label=Discord&logo=discord&logoColor=white)](https://discord.gg/ZZbKEZZkwK)
-[![Documentation](https://img.shields.io/badge/Documentation-📕-blue)](https://docs.droidrun.ai)
-[![Twitter Follow](https://img.shields.io/twitter/follow/droid_run?style=social)](https://x.com/droid_run)
-
-
-DroidRun is a powerful framework for controlling Android devices through LLM agents. It allows you to automate Android device interactions using natural language commands.
-
-## ✨ Features
-
-- Control Android devices with natural language commands
-- Supports multiple LLM providers (OpenAI, Anthropic, Gemini, Ollama, DeepSeek)
-- Planning capabilities for complex multi-step tasks
-- LlamaIndex integration for flexible LLM interactions
-- Easy to use CLI with enhanced debugging features
-- Extendable Python API for custom automations
-- Screenshot analysis for visual understanding of the device
-- Execution tracing with Arize Phoenix
-
-## 📦 Installation
-
-### 🚀 Option 1: Install from PyPI (Recommended)
-
-```bash
-pip install droidrun
-```
-
-### 🔧 Option 2: Install from Source
-
-```bash
-git clone https://github.com/droidrun/droidrun.git
-cd droidrun
-pip install -e .
-```
-
-## 📋 Prerequisites
-
-1. An Android device connected via USB or ADB over TCP/IP
-2. ADB (Android Debug Bridge) installed and configured
-3. DroidRun Portal app installed on your Android device
-4. API key for at least one of the supported LLM providers:
-   - OpenAI
-   - Anthropic
-   - Google Gemini
-
-### 🔧 Setting up ADB
-
-ADB (Android Debug Bridge) is required for DroidRun to communicate with your Android device:
-
-1. **Install ADB**:
-   - **Windows**: Download [Android SDK Platform Tools](https://developer.android.com/studio/releases/platform-tools) and extract the ZIP file
-   - **macOS**: `brew install android-platform-tools`
-   - **Linux**: `sudo apt install adb` (Ubuntu/Debian) or `sudo pacman -S android-tools` (Arch)
-
-2. **Add ADB to your PATH**:
-   - **Windows**: Add the path to the extracted platform-tools folder to your system's PATH environment variable
-   - **macOS/Linux**: Add the following to your ~/.bashrc or ~/.zshrc:
-     ```bash
-     export PATH=$PATH:/path/to/platform-tools
-     ```
-
-3. **Verify ADB installation**:
-   ```bash
-   adb version
-   ```
-
-4. **Enable USB debugging on your Android device**:
-   - Go to **Settings → About phone**
-   - Tap **Build number** 7 times to enable Developer options
-   - Go to **Settings → System → Developer options** (location may vary by device)
-   - Enable **USB debugging**
-
-## 🛠️ Setup
-
-### 📱 1. Install DroidRun Portal App
-
-DroidRun requires the DroidRun Portal app to be installed on your Android device:
-
-1. Download the DroidRun Portal APK from the [DroidRun Portal repository](https://github.com/droidrun/droidrun-portal)
-2. Use DroidRun to install the portal app:
-   ```bash
-   droidrun setup --path=/path/to/droidrun-portal.apk
-   ```
-
-Alternatively, you can use ADB to install it manually:
-```bash
-adb install -r /path/to/droidrun-portal.apk
-```
-
-### 🔑 2. Set up API keys
-
-Create a `.env` file in your working directory or set environment variables:
-
-```bash
-# Choose at least one of these based on your preferred provider
-export OPENAI_API_KEY="your_openai_api_key_here"
-export ANTHROPIC_API_KEY="your_anthropic_api_key_here"
-export GEMINI_API_KEY="your_gemini_api_key_here"
-export DEEPSEEK_API_KEY="your_deepseek_api_key_here"
-# For Ollama, no API key is needed
-```
-
-To load the environment variables from the `.env` file:
-
-```bash
-source .env
-```
-
-### 📱 3. Connect to an Android device
-
-Connect your device via USB or set up wireless ADB:
-
-```bash
-# List connected devices
-droidrun devices
-
-# Connect to a device over Wi-Fi
-droidrun connect 192.168.1.100
-```
-
-## 💻 Using the CLI
-
-DroidRun's CLI is designed to be simple and intuitive. You can use it in two ways:
-
-### 🚀 Basic Usage
-
-```bash
-# Format: droidrun "task description" [options]
-droidrun "Open the settings app"
-```
-
-### 🔌 With Provider Options
-
-```bash
-# Using OpenAI
-droidrun "Open the calculator app" --provider OpenAI --model gpt-4o-mini
-
-# Using Anthropic
-droidrun "Check the battery level" --provider Anthropic --model claude-3-sonnet-20240229
-
-# Using Gemini
-droidrun "Install and open Instagram" --provider Gemini --model models/gemini-2.5-pro-preview-05-06
-
-# Using Ollama (local)
-droidrun "Check battery level" --provider Ollama --model llama2
-```
-
-### ⚙️ Additional Options
-
-```bash
-# Specify a particular device
-droidrun "Open Chrome and search for weather" --device abc123
-
-# Enable vision capabilities
-droidrun "Analyze what's on the screen" --vision
-
-# Enable planning for complex tasks
-droidrun "Find and download a specific app" --reasoning
-
-# Enable execution tracing (requires Phoenix server running)
-droidrun "Debug this complex workflow" --tracing
-
-# Set maximum number of steps
-droidrun "Open settings and enable dark mode" --steps 20
-```
-
-## 📝 Creating a Minimal Test Script
-
-If you want to use DroidRun in your Python code rather than via the CLI, you can create a minimal test script:
-
-```python
-#!/usr/bin/env python3
-import asyncio
-from droidrun.agent.droid import DroidAgent
-from droidrun.agent.utils.llm_picker import load_llm
-from droidrun.tools import load_tools
-
-async def main():
-    # Load tools
-    tool_list, tools_instance = await load_tools()
-    
-    # Load LLM
-    llm = load_llm(
-        provider_name="Gemini",  # Case sensitive: OpenAI, Ollama, Anthropic, Gemini, DeepSeek
-        model="models/gemini-2.5-pro-preview-05-06",
-        temperature=0.2
-    )
-    
-    # Create and run the agent
-    agent = DroidAgent(
-        goal="Open the Settings app and check the Android version",
-        llm=llm,
-        tools_instance=tools_instance,
-        tool_list=tool_list,
-        vision=True,      # Enable vision for screen analysis
-        reasoning=True    # Enable planning for complex tasks
-    )
-    
-    # Run the agent
-    result = await agent.run()
-    print(f"Success: {result['success']}")
-    if result.get('reason'):
-        print(f"Reason: {result['reason']}")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-You can also use LlamaIndex directly:
-
-```python
-import asyncio
-from llama_index.llms.gemini import Gemini
-from droidrun.agent.droid import DroidAgent
-from droidrun.tools import load_tools
-
-async def main():
-    # Load tools
-    tool_list, tools_instance = await load_tools()
-    
-    # Create LlamaIndex LLM directly
-    llm = Gemini(
-        model="models/gemini-2.5-pro-preview-05-06",
-        temperature=0.2
-    )
-    
-    # Create and run the agent
-    agent = DroidAgent(
-        goal="Open the Settings app and check the Android version",
-        llm=llm,
-        tools_instance=tools_instance,
-        tool_list=tool_list
-    )
-    
-    # Run the agent
-    result = await agent.run()
-    print(f"Success: {result['success']}")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-## ❓ Troubleshooting
-
-### 🔑 API Key Issues
-
-If you encounter errors about missing API keys, ensure:
-1. You've set the correct environment variable for your chosen provider
-2. The API key is valid and has appropriate permissions
-3. You've correctly sourced your `.env` file or exported the variables manually
-
-### 📱 Device Connection Issues
-
-If you have trouble connecting to your device:
-1. Ensure USB debugging is enabled on your Android device
-2. Check that your device is recognized by ADB: `adb devices`
-3. For wireless connections, make sure your device and computer are on the same network
-
-### 🤖 LLM Provider Selection
-
-If DroidRun is using the wrong LLM provider:
-1. Explicitly specify the provider with `--provider` (in CLI) or `llm_provider=` (in code)
-2. When using Gemini, ensure you have set `GEMINI_API_KEY` and specified `--provider gemini`
-
-### 📊 Tracing Issues
-
-If you're using the tracing feature:
-1. Make sure to install Arize Phoenix: `pip install "arize-phoenix[llama-index]"`
-2. Start the Phoenix server before running your command: `phoenix serve`
-3. Access the tracing UI at http://localhost:6006 after execution
-
-### 🎬 Demo Videos
-
-1. **Shopping Assistant**: Watch how DroidRun searches Amazon for headphones and sends the top 3 products to a colleague on WhatsApp.
-   
-   Prompt: "Go to Amazon, search for headphones and write the top 3 products to my colleague on WhatsApp."
-   
-   [![Shopping Assistant Demo](https://img.youtube.com/vi/VQK3JcifgwU/0.jpg)](https://www.youtube.com/watch?v=VQK3JcifgwU)
-
-2. **Social Media Automation**: See DroidRun open X (Twitter) and post "Hello World".
-   
-   Prompt: "Open up X and post Hello World."
-   
-   [![Social Media Automation Demo](https://img.youtube.com/vi/i4-sDQhzt_M/0.jpg)](https://www.youtube.com/watch?v=i4-sDQhzt_M)
-
-## 💡 Example Use Cases
-
-- Automated UI testing of Android applications
-- Creating guided workflows for non-technical users
-- Automating repetitive tasks on Android devices
-- Remote assistance for less technical users
-- Exploring Android UI with natural language commands
-
-## 🗺️ Roadmap
-
-### 🤖 Agent:
-- **Improve memory**: Enhance context retention for complex multi-step tasks
-- **Expand planning capabilities**: Add support for more complex reasoning strategies
-- **Add Integrations**: Support more LLM providers and agent frameworks (LangChain, Agno etc.)
-
-### ⚙️ Automations:
-- **Create Automation Scripts**: Generate reusable scripts from agent actions that can be scheduled or shared
-
-### ☁️ Cloud:
-- **Hosted version**: Remote device control via web interface without local setup
-- **Add-Ons**: Marketplace for extensions serving specific use cases
-- **Proxy Hours**: Cloud compute time with tiered pricing for running automations
-- **Droidrun AppStore**: Simple installation of Apps on your hosted devices
-
-## 👥 Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## 📄 License
-
-This project is licensed under the MIT License - see the LICENSE file for details. 

droidrun-0.2.0.dist-info/RECORD

@@ -1,32 +0,0 @@
-droidrun/__init__.py,sha256=LhCCBKH9M1PJG3jAsCG84zyK2WkbTR3WI58LrzuSXMA,659
-droidrun/__main__.py,sha256=ganC_pSTITSVwVmdEfd6qEkrHutt3UVoalXTBianP2w,97
-droidrun/adb/__init__.py,sha256=tBhoSFmkevb_xQcCfdrigPut9zAU1J4bagpT-TgBj8c,221
-droidrun/adb/device.py,sha256=yMndMpO-R0lPmLoZANr-aou8HldyD3TLCP9J5ZjJJao,10992
-droidrun/adb/manager.py,sha256=9xohDCbw8XvWW2Esglpcnk9H24hKJG3e9SkCBiFWlDI,2704
-droidrun/adb/wrapper.py,sha256=Yz3_JSIidq-5bf-t0UfawTutMaLrINS_1Y15m_Uss4g,7093
-droidrun/agent/codeact/__init__.py,sha256=B1wskXGB-xeGCZnUIZxBaEXz1f0YSxAHRljKqMH6nXQ,308
-droidrun/agent/codeact/codeact_agent.py,sha256=lyJfBmPshR50-k6wtrOBe3IwSJueiDBpuiGNaWxoagA,16015
-droidrun/agent/codeact/events.py,sha256=4O0fJWu_DwJoJF8SqQr8CpALsaSKNOGKksVS9yWWBsY,934
-droidrun/agent/codeact/prompts.py,sha256=vRt0z34ND-p1RGkfXbp96Q_-z8HbHmjVB9c2LHnzl7Q,4110
-droidrun/agent/droid/__init__.py,sha256=wSuPd9wDEreFYlclfmXEqiqKq0wJQTT3v3PY-WhS6q0,264
-droidrun/agent/droid/droid_agent.py,sha256=3JnCkusacpBYiWVFBnVRMGbFt61CJ2_bOn_QW-lFUTk,18576
-droidrun/agent/planner/__init__.py,sha256=CWWEA9H6xM-il832tpTG19bMl0j9r4fYXMLikqUGNeU,372
-droidrun/agent/planner/events.py,sha256=wWBz5F7_cyNQHJLZp-n-1ML89M82_chcdhUxXTj3k8M,381
-droidrun/agent/planner/prompts.py,sha256=8kWudnq8dPuhVpugyT53Y-NPLZvlQadIrjUUrKgy5h4,7065
-droidrun/agent/planner/task_manager.py,sha256=u70Syr9OiGKU4IOy9oqblLYjHfELBl-m5nmQc35RPqI,13348
-droidrun/agent/planner/workflow.py,sha256=jRLVkEejQk1Rul6mxBXLDtReS8K0G1UFAJdH1JHtXOk,18797
-droidrun/agent/utils/async_utils.py,sha256=Bf4J2TmT7Fbp4JKtvS1lfOYBmJ3lBUQ9D0lBYQfChus,2266
-droidrun/agent/utils/chat_utils.py,sha256=lSp6snn15EhrZj4eGGN3De710Btub5jV_euSz9LYUu4,3891
-droidrun/agent/utils/executer.py,sha256=PKgUwTer-IezZ-NecCGrgcRHjmRIm7RTmgwrUaXJSlQ,3535
-droidrun/agent/utils/llm_picker.py,sha256=KSjbOw6oqKuIQUm8lKDEhY13PTd5U70vY9Bb150AvBE,5782
-droidrun/cli/__init__.py,sha256=ra9bKoHTIkgRsVFRlWztROPPRswMv_A-wc2b2e0plmo,155
-droidrun/cli/main.py,sha256=NQKjHSxMTDSjNyXLnv8KnUQgTw61RFWRVKpL2aukT3M,21197
-droidrun/tools/__init__.py,sha256=_wTPn8jhAjtpMdHXc5LlCa2pokpCuM1kcEzxC94gpVg,237
-droidrun/tools/actions.py,sha256=0KM-eyJnWx4kIttKG7MVA8gwn9DNoxQv8It0nCyV-GE,34002
-droidrun/tools/device.py,sha256=Aq2NzERtFdPLiXXQ_km7DJbw2LAPgpCIf5DQB-VpzCA,1078
-droidrun/tools/loader.py,sha256=Glpxz7t1IDlitxcUslmhwPTTpNpx8y_ivLN6JF3CDoE,2372
-droidrun-0.2.0.dist-info/METADATA,sha256=mDCK2ij4tifCuew8zv8aii-6dRAyfv2ehs7GfvUknus,12479
-droidrun-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-droidrun-0.2.0.dist-info/entry_points.txt,sha256=o259U66js8TIybQ7zs814Oe_LQ_GpZsp6a9Cr-xm5zE,51
-droidrun-0.2.0.dist-info/licenses/LICENSE,sha256=s-uxn9qChu-kFdRXUp6v_0HhsaJ_5OANmfNOFVm2zdk,1069
-droidrun-0.2.0.dist-info/RECORD,,