e2b-desktop 0.0.1__tar.gz

e2b_desktop-0.0.1/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: e2b-desktop
+Version: 0.0.1
+Summary: E2B Desktop Sandbox - Deskstop sandbox in cloud powered by E2B
+Home-page: https://e2b.dev/
+License: Apache-2.0
+Author: e2b
+Author-email: hello@e2b.dev
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: e2b (>=1.0.1,<2.0.0)
+Requires-Dist: easyocr (>=1.7.2,<2.0.0)
+Requires-Dist: numpy (==1.24)
+Requires-Dist: opencv-python (==4.8.1.78)
+Project-URL: Bug Tracker, https://github.com/e2b-dev/desktop/issues
+Project-URL: Repository, https://github.com/e2b-dev/desktop/tree/main/python
+Description-Content-Type: text/markdown
+
+# E2B Desktop Sandbox (beta)
+
+E2B Desktop Sandbox is an isolated cloud environment with a desktop-like interface powered by [E2B](https://e2b.dev).
+
+Launching E2B Sandbox takes about 300-500ms. You can customize the desktop environment and preinstall any dependencies you want using our [custom sandbox templates](https://e2b.dev/docs/sandbox-template).
+
+![Desktop Sandbox](screenshot.png)
+
+**Work in progress**
+This repository is a work in progress. We welcome feedback and contributions. Here's the list of features we're working on:
+- [ ] JavaScript SDK
+- [ ] Streaming live desktop
+- [ ] Tests
+- [ ] Docstrings
+
+## Getting started
+The E2B Desktop Sandbox is built on top of [E2B Sandbox](https://e2b.dev/docs).
+
+### 1. Get E2B API key
+Sign up at [E2B](https://e2b.dev) and get your API key.
+Set environment variable `E2B_API_KEY` with your API key.
+
+### 2. Install SDK
+**Python**
+```bash
+pip install e2b-desktop
+```
+
+**JavaScript**
+```bash
+Coming soon
+```
+
+### 3. Create Desktop Sandbox
+```python
+from e2b_desktop import Sandbox
+
+desktop = Sandbox()
+```
+
+## Features
+
+### Mouse control
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+desktop.double_click()
+desktop.left_click()
+desktop.right_click()
+desktop.middle_click()
+desktop.scroll(10) # Scroll by the amount. Positive for up, negative for down.
+desktop.mouse_move(100, 200) # Move to x, y coordinates
+```
+
+### Locate on screen
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Find "Home" text on the screen and return the coordinates
+x, y = desktop.locate_on_screen("Home")
+# Move the mouse to the coordinates
+desktop.mouse_move(x, y)
+```
+
+### Keyboard control
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+desktop.write("Hello, world!") # Write text at the current cursor position
+desktop.hotkey("ctrl", "c") # Press ctrl+c
+```
+
+### Screenshot
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Take a screenshot and save it as "screenshot.png" locally
+desktop.screenshot("screenshot.png")
+```
+
+### Open file
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Open file with default application
+desktop.files.write("/home/user/index.js", "console.log('hello')") # First create the file
+desktop.open("/home/user/index.js") # Then open it
+```
+
+### Run any bash commands
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Run any bash command
+desktop.commands.run("ls -la /home/user")
+```
+
+### Run PyAutoGUI commands
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Run any PyAutoGUI command
+desktop.pyautogui("pyautogui.click()")
+```
+
+<!-- ### Customization
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+``` -->
+
+## Under the hood
+You can use [PyAutoGUI](https://pyautogui.readthedocs.io/en/latest/) to control the whole environment programmatically.
+
+The desktop-like environment is based on Linux and [Xfce](https://www.xfce.org/) at the moment. We chose Xfce because it's a fast and lightweight environment that's also popular and actively supported. However, this Sandbox template is fully customizable and you can create your own desktop environment.
+Check out the code [here](./template/)
+

e2b_desktop-0.0.1/README.md

@@ -0,0 +1,123 @@
+# E2B Desktop Sandbox (beta)
+
+E2B Desktop Sandbox is an isolated cloud environment with a desktop-like interface powered by [E2B](https://e2b.dev).
+
+Launching E2B Sandbox takes about 300-500ms. You can customize the desktop environment and preinstall any dependencies you want using our [custom sandbox templates](https://e2b.dev/docs/sandbox-template).
+
+![Desktop Sandbox](screenshot.png)
+
+**Work in progress**
+This repository is a work in progress. We welcome feedback and contributions. Here's the list of features we're working on:
+- [ ] JavaScript SDK
+- [ ] Streaming live desktop
+- [ ] Tests
+- [ ] Docstrings
+
+## Getting started
+The E2B Desktop Sandbox is built on top of [E2B Sandbox](https://e2b.dev/docs).
+
+### 1. Get E2B API key
+Sign up at [E2B](https://e2b.dev) and get your API key.
+Set environment variable `E2B_API_KEY` with your API key.
+
+### 2. Install SDK
+**Python**
+```bash
+pip install e2b-desktop
+```
+
+**JavaScript**
+```bash
+Coming soon
+```
+
+### 3. Create Desktop Sandbox
+```python
+from e2b_desktop import Sandbox
+
+desktop = Sandbox()
+```
+
+## Features
+
+### Mouse control
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+desktop.double_click()
+desktop.left_click()
+desktop.right_click()
+desktop.middle_click()
+desktop.scroll(10) # Scroll by the amount. Positive for up, negative for down.
+desktop.mouse_move(100, 200) # Move to x, y coordinates
+```
+
+### Locate on screen
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Find "Home" text on the screen and return the coordinates
+x, y = desktop.locate_on_screen("Home")
+# Move the mouse to the coordinates
+desktop.mouse_move(x, y)
+```
+
+### Keyboard control
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+desktop.write("Hello, world!") # Write text at the current cursor position
+desktop.hotkey("ctrl", "c") # Press ctrl+c
+```
+
+### Screenshot
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Take a screenshot and save it as "screenshot.png" locally
+desktop.screenshot("screenshot.png")
+```
+
+### Open file
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Open file with default application
+desktop.files.write("/home/user/index.js", "console.log('hello')") # First create the file
+desktop.open("/home/user/index.js") # Then open it
+```
+
+### Run any bash commands
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Run any bash command
+desktop.commands.run("ls -la /home/user")
+```
+
+### Run PyAutoGUI commands
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+
+# Run any PyAutoGUI command
+desktop.pyautogui("pyautogui.click()")
+```
+
+<!-- ### Customization
+```python
+from e2b_desktop import Sandbox
+desktop = Sandbox()
+``` -->
+
+## Under the hood
+You can use [PyAutoGUI](https://pyautogui.readthedocs.io/en/latest/) to control the whole environment programmatically.
+
+The desktop-like environment is based on Linux and [Xfce](https://www.xfce.org/) at the moment. We chose Xfce because it's a fast and lightweight environment that's also popular and actively supported. However, this Sandbox template is fully customizable and you can create your own desktop environment.
+Check out the code [here](./template/)

e2b_desktop-0.0.1/e2b_desktop/__init__.py

@@ -0,0 +1,3 @@
+from e2b import *
+
+from .main import Sandbox

e2b_desktop-0.0.1/e2b_desktop/main.py

@@ -0,0 +1,198 @@
+import uuid
+import easyocr
+import numpy as np
+import cv2
+
+from typing import Callable, Optional, Union
+from e2b import Sandbox as SandboxBase
+
+
+class Sandbox(SandboxBase):
+    default_template = "desktop"
+
+    def screenshot(
+        self,
+        name: str,
+        on_stdout: Optional[Callable[[str], None]] = None,
+        on_stderr: Optional[Callable[[str], None]] = None,
+    ):
+        """
+        Take a screenshot and save it to the given name.
+        :param name: The name of the screenshot file to save locally.
+        """
+        screenshot_path = f"/home/user/screenshot-{uuid.uuid4()}.png"
+
+        self.commands.run(
+            f"scrot --pointer {screenshot_path}",
+            on_stderr=on_stderr,
+            on_stdout=on_stdout,
+            cwd="/home/user",
+        )
+
+        with open(name, "wb") as f:
+            file = self.files.read(screenshot_path, format="bytes")
+            f.write(file)
+
+    def left_click(self):
+        """
+        Left click on the current mouse position.
+        """
+        return self.pyautogui("pyautogui.click()")
+
+    def double_click(self):
+        """
+        Double left click on the current mouse position.
+        """
+        return self.pyautogui("pyautogui.doubleClick()")
+
+    def right_click(self):
+        """
+        Right click on the current mouse position.
+        """
+        return self.pyautogui("pyautogui.rightClick()")
+
+    def middle_click(self):
+        return self.pyautogui("pyautogui.middleClick()")
+
+    def scroll(self, amount: int):
+        return self.pyautogui(f"pyautogui.scroll({amount})")
+
+    def mouse_move(
+        self,
+        x_or_coords: Union[int, tuple[int, int]],
+        y: Optional[int] = None,
+    ):
+        """
+        Move the mouse to the given coordinates.
+        :param x_or_coords: The x coordinate or a tuple of (x, y).
+        :param y: The y coordinate, if x_or_coords is not a tuple.
+        """
+        if isinstance(x_or_coords, tuple):
+            x, y = x_or_coords
+        return self.pyautogui(f"pyautogui.moveTo({x}, {y})")
+
+    def locate_on_screen(self, text: str) -> tuple[int, int] | None:
+        """
+        Locate the text on the screen and return the position.
+        :param text: The text to locate.
+        """
+
+        # Take a screenshot
+        screenshot_path = f"/home/user/screenshot-{uuid.uuid4()}.png"
+        self.commands.run(f"scrot --pointer {screenshot_path}")
+        image_bytes = self.files.read(screenshot_path, format="bytes")
+
+        # Convert bytes to numpy array
+        nparr = np.frombuffer(image_bytes, np.uint8)
+        image = cv2.imdecode(nparr, cv2.IMREAD_COLOR)
+
+        # Initialize EasyOCR reader
+        reader = easyocr.Reader(["en"])
+
+        # Perform OCR
+        results = reader.readtext(image)
+
+        # Find the text in the results
+        for bbox, detected_text, prob in results:
+            if text.lower() in detected_text.lower():
+                # Calculate center of bounding box
+                (top_left, top_right, bottom_right, bottom_left) = bbox
+                center_x = (top_left[0] + bottom_right[0]) / 2
+                center_y = (top_left[1] + bottom_right[1]) / 2
+                return center_x, center_y
+        return None
+
+    def get_cursor_position(self):
+        """
+        Get the current cursor position.
+        :return: A tuple with the x and y coordinates.
+        """
+        # We save the value to a file because stdout contains warnings about Xauthority.
+        self.pyautogui(
+            """
+x, y = pyautogui.position()
+with open("/tmp/cursor_position.txt", "w") as f:
+    f.write(str(x) + " " + str(y))
+"""
+        )
+        # pos is like this: 100 200
+        pos = self.files.read("/tmp/cursor_position.txt")
+        return tuple(map(int, pos.split(" ")))
+
+    def get_screen_size(self):
+        """
+        Get the current screen size.
+        :return: A tuple with the width and height.
+        """
+        # We save the value to a file because stdout contains warnings about Xauthority.
+        self.pyautogui(
+            """
+width, height = pyautogui.size()
+with open("/tmp/size.txt", "w") as f:
+    f.write(str(width) + " " + str(height))
+"""
+        )
+        # size is like this: 100 200
+        size = self.files.read("/tmp/size.txt")
+        return tuple(map(int, size.split(" ")))
+
+    def write(self, text: str):
+        """
+        Write the given text at the current cursor position.
+        :param text: The text to write.
+        """
+        return self.pyautogui(f"pyautogui.write({text!r})")
+
+    def hotkey(self, *keys):
+        """
+        Press a hotkey.
+        :param keys: The keys to press.
+        """
+        return self.pyautogui(f"pyautogui.hotkey({keys!r})")
+
+    def open(self, file_or_url: str):
+        """
+        Open a file or a URL in the default application.
+        :param file_or_url: The file or URL to open.
+        """
+        return self.commands.run(f"xdg-open {file_or_url}", background=True)
+
+    def install_package(self, package: str):
+        """
+        Install a package with apt.
+        :param package: The package to install.
+        """
+        return self.commands.run(f"apt-get install -y {package}")
+
+    @staticmethod
+    def _wrap_pyautogui_code(code: str):
+        return f"""
+import pyautogui
+import os
+import Xlib.display
+
+display = Xlib.display.Display(os.environ["DISPLAY"])
+pyautogui._pyautogui_x11._display = display
+
+{code}
+exit(0)
+"""
+
+    def pyautogui(
+        self,
+        pyautogui_code: str,
+        on_stdout: Optional[Callable[[str], None]] = None,
+        on_stderr: Optional[Callable[[str], None]] = None,
+    ):
+        code_path = f"/home/user/code-{uuid.uuid4()}.py"
+
+        code = self._wrap_pyautogui_code(pyautogui_code)
+
+        self.files.write(code_path, code)
+
+        out = self.commands.run(
+            f"python {code_path}",
+            on_stdout=on_stdout,
+            on_stderr=on_stderr,
+        )
+        return out

e2b_desktop-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[tool.poetry]
+name = "e2b-desktop"
+version = "0.0.1"
+description = "E2B Desktop Sandbox - Deskstop sandbox in cloud powered by E2B"
+authors = ["e2b <hello@e2b.dev>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://e2b.dev/"
+repository = "https://github.com/e2b-dev/desktop/tree/main/python"
+packages = [{ include = "e2b_desktop" }]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+
+e2b = "^1.0.1"
+easyocr = "^1.7.2"
+numpy = "1.24"
+opencv-python = "4.8.1.78"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.3.0"
+pytest = "^7.4.0"
+python-dotenv = "^1.0.0"
+pytest-dotenv = "^0.5.2"
+pytest-xdist = "^3.6.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/e2b-dev/desktop/issues"