oagi 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

oagi/__init__.py

@@ -18,12 +18,14 @@ from oagi.exceptions import (
     ServerError,
     ValidationError,
 )
+from oagi.pil_image import PILImage
 from oagi.pyautogui_action_handler import PyautoguiActionHandler
 from oagi.screenshot_maker import ScreenshotMaker
 from oagi.short_task import ShortTask
 from oagi.single_step import single_step
 from oagi.sync_client import ErrorDetail, ErrorResponse, LLMResponse, SyncClient
 from oagi.task import Task
+from oagi.types import ImageConfig
 
 __all__ = [
     # Core classes
@@ -32,9 +34,13 @@ __all__ = [
     "SyncClient",
     # Functions
     "single_step",
+    # Image classes
+    "PILImage",
     # Handler classes
     "PyautoguiActionHandler",
     "ScreenshotMaker",
+    # Configuration
+    "ImageConfig",
     # Response models
     "LLMResponse",
     "ErrorResponse",

oagi/pil_image.py

@@ -0,0 +1,98 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+
+import io
+from typing import Optional
+
+import pyautogui
+from PIL import Image as PILImageLib
+
+from .types.models.image_config import ImageConfig
+
+
+class PILImage:
+    """PIL image wrapper with transformation capabilities."""
+
+    def __init__(self, image: PILImageLib.Image, config: ImageConfig | None = None):
+        """Initialize with a PIL image and optional config."""
+        self.image = image
+        self.config = config or ImageConfig()
+        self._cached_bytes: Optional[bytes] = None
+
+    @classmethod
+    def from_file(cls, path: str, config: ImageConfig | None = None) -> "PILImage":
+        """Create PILImage from file path."""
+        image = PILImageLib.open(path)
+        return cls(image, config)
+
+    @classmethod
+    def from_bytes(cls, data: bytes, config: ImageConfig | None = None) -> "PILImage":
+        """Create PILImage from raw bytes."""
+        image = PILImageLib.open(io.BytesIO(data))
+        return cls(image, config)
+
+    @classmethod
+    def from_screenshot(cls, config: ImageConfig | None = None) -> "PILImage":
+        """Create PILImage from screenshot."""
+        screenshot = pyautogui.screenshot()
+        return cls(screenshot, config)
+
+    def transform(self, config: ImageConfig) -> "PILImage":
+        """Apply transformations (resize) based on config and return new PILImage."""
+        # Apply resize if needed
+        transformed = self._resize(self.image, config)
+        # Return new PILImage with the config (format conversion happens on read())
+        return PILImage(transformed, config)
+
+    def _resize(
+        self, image: PILImageLib.Image, config: ImageConfig
+    ) -> PILImageLib.Image:
+        """Resize image based on config."""
+        if config.width or config.height:
+            # Get target dimensions (use original if not specified)
+            target_width = config.width or image.width
+            target_height = config.height or image.height
+
+            # Map resample string to PIL constant
+            resample_map = {
+                "NEAREST": PILImageLib.NEAREST,
+                "BILINEAR": PILImageLib.BILINEAR,
+                "BICUBIC": PILImageLib.BICUBIC,
+                "LANCZOS": PILImageLib.LANCZOS,
+            }
+            resample = resample_map[config.resample]
+
+            # Resize to exact dimensions
+            return image.resize((target_width, target_height), resample)
+        return image
+
+    def _convert_format(self, image: PILImageLib.Image) -> bytes:
+        """Convert image to configured format (PNG or JPEG)."""
+        buffer = io.BytesIO()
+        save_kwargs = {"format": self.config.format}
+
+        if self.config.format == "JPEG":
+            save_kwargs["quality"] = self.config.quality
+            # Convert RGBA to RGB for JPEG if needed
+            if image.mode == "RGBA":
+                rgb_image = PILImageLib.new("RGB", image.size, (255, 255, 255))
+                rgb_image.paste(image, mask=image.split()[3])
+                rgb_image.save(buffer, **save_kwargs)
+            else:
+                image.save(buffer, **save_kwargs)
+        elif self.config.format == "PNG":
+            save_kwargs["optimize"] = self.config.optimize
+            image.save(buffer, **save_kwargs)
+
+        return buffer.getvalue()
+
+    def read(self) -> bytes:
+        """Read image as bytes with current config (implements Image protocol)."""
+        if self._cached_bytes is None:
+            self._cached_bytes = self._convert_format(self.image)
+        return self._cached_bytes

oagi/screenshot_maker.py

@@ -6,68 +6,36 @@
 #  Licensed under the MIT License.
 # -----------------------------------------------------------------------------
 
-import io
 from typing import Optional
 
-import pyautogui
-
+from .pil_image import PILImage
 from .types import Image
-
-
-class FileImage:
-    def __init__(self, path: str):
-        self.path = path
-        with open(path, "rb") as f:
-            self.data = f.read()
-
-    def read(self) -> bytes:
-        return self.data
-
-
-class MockImage:
-    def read(self) -> bytes:
-        return b"mock screenshot data"
-
-
-class ScreenshotImage:
-    """Image class that wraps a pyautogui screenshot."""
-
-    def __init__(self, screenshot):
-        """Initialize with a PIL Image from pyautogui."""
-        self.screenshot = screenshot
-        self._cached_bytes: Optional[bytes] = None
-
-    def read(self) -> bytes:
-        """Convert the screenshot to bytes (PNG format)."""
-        if self._cached_bytes is None:
-            # Convert PIL Image to bytes
-            buffer = io.BytesIO()
-            self.screenshot.save(buffer, format="PNG")
-            self._cached_bytes = buffer.getvalue()
-        return self._cached_bytes
+from .types.models.image_config import ImageConfig
 
 
 class ScreenshotMaker:
     """Takes screenshots using pyautogui."""
 
-    def __init__(self):
-        self._last_screenshot: Optional[ScreenshotImage] = None
+    def __init__(self, config: ImageConfig | None = None):
+        self.config = config or ImageConfig()
+        self._last_image: Optional[PILImage] = None
 
     def __call__(self) -> Image:
-        """Take a screenshot and return it as an Image."""
-        # Take a screenshot using pyautogui
-        screenshot = pyautogui.screenshot()
+        """Take and process a screenshot."""
+        # Create PILImage from screenshot
+        pil_image = PILImage.from_screenshot()
 
-        # Wrap it in our ScreenshotImage class
-        screenshot_image = ScreenshotImage(screenshot)
+        # Apply transformation if config is set
+        if self.config:
+            pil_image = pil_image.transform(self.config)
 
-        # Store as the last screenshot
-        self._last_screenshot = screenshot_image
+        # Store as the last image
+        self._last_image = pil_image
 
-        return screenshot_image
+        return pil_image
 
     def last_image(self) -> Image:
         """Return the last screenshot taken, or take a new one if none exists."""
-        if self._last_screenshot is None:
+        if self._last_image is None:
             return self()
-        return self._last_screenshot
+        return self._last_image

oagi/short_task.py

@@ -16,6 +16,14 @@ logger = get_logger("short_task")
 class ShortTask(Task):
     """Task implementation with automatic mode for short-duration tasks."""
 
+    def __init__(
+        self,
+        api_key: str | None = None,
+        base_url: str | None = None,
+        model: str = "vision-model-v1",
+    ):
+        super().__init__(api_key=api_key, base_url=base_url, model=model)
+
     def auto_mode(
         self,
         task_desc: str,

oagi/single_step.py

@@ -8,6 +8,7 @@
 
 from pathlib import Path
 
+from .pil_image import PILImage
 from .task import Task
 from .types import Image, Step
 
@@ -59,12 +60,12 @@ def single_step(
         ...     screenshot=image
         ... )
     """
-    # Convert file paths to bytes
+    # Convert file paths to bytes using PILImage
     if isinstance(screenshot, (str, Path)):
         path = Path(screenshot) if isinstance(screenshot, str) else screenshot
         if path.exists():
-            with open(path, "rb") as f:
-                screenshot_bytes = f.read()
+            pil_image = PILImage.from_file(str(path))
+            screenshot_bytes = pil_image.read()
         else:
             raise FileNotFoundError(f"Screenshot file not found: {path}")
     elif isinstance(screenshot, bytes):

oagi/task.py

@@ -16,13 +16,18 @@ logger = get_logger("task")
 class Task:
     """Base class for task automation with the OAGI API."""
 
-    def __init__(self, api_key: str | None = None, base_url: str | None = None):
+    def __init__(
+        self,
+        api_key: str | None = None,
+        base_url: str | None = None,
+        model: str = "vision-model-v1",
+    ):
         self.client = SyncClient(base_url=base_url, api_key=api_key)
         self.api_key = self.client.api_key
         self.base_url = self.client.base_url
         self.task_id: str | None = None
         self.task_description: str | None = None
-        self.model = "vision-model-v1"  # default model
+        self.model = model
 
     def init_task(self, task_desc: str, max_steps: int = 5):
         """Initialize a new task with the given description."""

oagi/types/__init__.py

@@ -9,6 +9,14 @@
 from .action_handler import ActionHandler
 from .image import Image
 from .image_provider import ImageProvider
-from .models import Action, ActionType, Step
+from .models import Action, ActionType, ImageConfig, Step
 
-__all__ = ["Action", "ActionType", "Image", "Step", "ActionHandler", "ImageProvider"]
+__all__ = [
+    "Action",
+    "ActionType",
+    "Image",
+    "ImageConfig",
+    "Step",
+    "ActionHandler",
+    "ImageProvider",
+]

oagi/types/models/__init__.py

@@ -7,6 +7,7 @@
 # -----------------------------------------------------------------------------
 
 from .action import Action, ActionType
+from .image_config import ImageConfig
 from .step import Step
 
-__all__ = ["Action", "ActionType", "Step"]
+__all__ = ["Action", "ActionType", "ImageConfig", "Step"]

oagi/types/models/image_config.py

@@ -0,0 +1,47 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+
+from typing import Literal
+
+from pydantic import BaseModel, Field, field_validator
+
+
+class ImageConfig(BaseModel):
+    """Configuration for image capture and processing."""
+
+    format: Literal["PNG", "JPEG"] = Field(
+        default="JPEG", description="Image format for encoding"
+    )
+    quality: int = Field(
+        default=85,
+        ge=1,
+        le=100,
+        description="JPEG quality (1-100, only applies to JPEG format)",
+    )
+    width: int | None = Field(
+        default=1260, description="Target width in pixels (will resize to exact size)"
+    )
+    height: int | None = Field(
+        default=700, description="Target height in pixels (will resize to exact size)"
+    )
+    optimize: bool = Field(
+        default=False,
+        description="Enable PNG optimization (only applies to PNG format)",
+    )
+    resample: Literal["NEAREST", "BILINEAR", "BICUBIC", "LANCZOS"] = Field(
+        default="LANCZOS", description="Resampling filter for resizing"
+    )
+
+    @field_validator("quality")
+    @classmethod
+    def validate_quality(cls, v: int, info) -> int:
+        """Validate quality parameter based on format."""
+        values = info.data
+        if values.get("format") == "PNG" and v != 85:
+            return 85
+        return v

oagi-0.3.0.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.3
+Name: oagi
+Version: 0.3.0
+Summary: Official API of OpenAGI Foundation
+Project-URL: Homepage, https://github.com/agiopen-org/oagi
+Author-email: OpenAGI Foundation <contact@agiopen.org>
+License: MIT License
+        
+        Copyright (c) 2025 OpenAGI Foundation
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: pyautogui>=0.9.54
+Requires-Dist: pydantic>=2.0.0
+Description-Content-Type: text/markdown
+
+# OAGI Python SDK
+
+Python SDK for the OAGI API - vision-based task automation.
+
+## Installation
+
+```bash
+pip install oagi  # requires Python >= 3.10
+```
+
+## Quick Start
+
+Set your API credentials:
+```bash
+export OAGI_API_KEY="your-api-key"
+export OAGI_BASE_URL="https://api.oagi.com"  # or your server URL
+```
+
+### Single-Step Analysis
+
+Analyze a screenshot and get recommended actions:
+
+```python
+from oagi import single_step
+
+step = single_step(
+    task_description="Click the submit button",
+    screenshot="screenshot.png"  # or bytes, or Image object
+)
+
+print(f"Actions: {step.actions}")
+print(f"Complete: {step.is_complete}")
+```
+
+### Automated Task Execution
+
+Run tasks automatically with screenshot capture and action execution:
+
+```python
+from oagi import ShortTask, ScreenshotMaker, PyautoguiActionHandler
+
+task = ShortTask()
+completed = task.auto_mode(
+    "Search weather on Google",
+    max_steps=10,
+    executor=PyautoguiActionHandler(),  # Executes mouse/keyboard actions
+    image_provider=ScreenshotMaker(),    # Captures screenshots
+)
+```
+
+### Image Processing
+
+Process and optimize images before sending to API:
+
+```python
+from oagi import PILImage, ImageConfig
+
+# Load and compress an image
+image = PILImage.from_file("large_screenshot.png")
+config = ImageConfig(
+    format="JPEG",
+    quality=85,
+    width=1260,
+    height=700
+)
+compressed = image.transform(config)
+
+# Use with single_step
+step = single_step("Click button", screenshot=compressed)
+```
+
+## Examples
+
+See the [`examples/`](examples/) directory for more usage patterns:
+- `google_weather.py` - Basic task execution with `ShortTask`
+- `single_step.py` - Basic single-step inference
+- `screenshot_with_config.py` - Image compression and optimization
+- `execute_task_auto.py` - Automated task execution
+
+## Documentation
+
+
+## License
+
+MIT

oagi-0.3.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+oagi/__init__.py,sha256=1pewp0wOcGI8urjOOCskwiJC9VghhGCRpsslf-VUiLI,1493
+oagi/exceptions.py,sha256=VMwVS8ouE9nHhBpN3AZMYt5_U2kGcihWaTnBhoQLquo,1662
+oagi/logging.py,sha256=CWe89mA5MKTipIvfrqSYkv2CAFNBSwHMDQMDkG_g64g,1350
+oagi/pil_image.py,sha256=Zp7YNwyE_AT25ZEFsWKbzMxbO8JOQsJ1Espph5ye8k8,3804
+oagi/pyautogui_action_handler.py,sha256=LBWmtqkXzZSJo07s3uOw-NWUE9rZZtbNAx0YI83pCbk,5482
+oagi/screenshot_maker.py,sha256=sVuW7jn-K4FmLhmYI-akdNI-UVcTeBzh9P1_qJhoq1s,1282
+oagi/short_task.py,sha256=fJcirqD7X3_GyINTGdOoe6wi-VFHfP-C8m-zxCvgY5M,1779
+oagi/single_step.py,sha256=djhGOHzA5Y3-9_ity9QiJr_ObZZ04blSmNZsLXXXfkg,2939
+oagi/sync_client.py,sha256=E6EgFIe-H91rdsPhF1puwrBTpOnKaL6JA1WHR4R-CLY,9395
+oagi/task.py,sha256=JfsugIhBrwDmi1xOEVQdqmXsGFK-H4p17-B4rM8kbWs,4001
+oagi/types/__init__.py,sha256=dj_UWdpRzhuVyi-pegQAv2V0f1DxidFxjWUhpcWzYKE,608
+oagi/types/action_handler.py,sha256=NH8E-m5qpGqWcXzTSWfF7W0Xdp8SkzJsbhCmQ0B96cg,1075
+oagi/types/image.py,sha256=KgPCCTJ6D5vHIaGZdbTE7eQEa1WlT6G9tf59ZuUCV2U,537
+oagi/types/image_provider.py,sha256=oYFdOYznrK_VOR9egzOjw5wFM5w8EY2sY01pH0ANAgU,1112
+oagi/types/models/__init__.py,sha256=bVzzGxb6lVxAQyJpy0Z1QknSe-xC3g4OIDr7t-p_3Ys,467
+oagi/types/models/action.py,sha256=8Xd3IcH32ENq7uXczo-mbQ736yUOGxO_TaZTfHVRY7w,935
+oagi/types/models/image_config.py,sha256=tl6abVg_-IAPLwpaWprgknXu7wRWriMg-AEVyUX73v0,1567
+oagi/types/models/step.py,sha256=RSI4H_2rrUBq_xyCoWKaq7JHdJWNobtQppaKC1l0aWU,471
+oagi-0.3.0.dist-info/METADATA,sha256=BtkLuhcIXhL43C23nZa6uZNcUuhlhXjJ67OaaXxeEmI,3461
+oagi-0.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+oagi-0.3.0.dist-info/licenses/LICENSE,sha256=sy5DLA2M29jFT4UfWsuBF9BAr3FnRkYtnAu6oDZiIf8,1075
+oagi-0.3.0.dist-info/RECORD,,

oagi-0.2.1.dist-info/METADATA

@@ -1,55 +0,0 @@
-Metadata-Version: 2.3
-Name: oagi
-Version: 0.2.1
-Summary: Official API of OpenAGI Foundation
-Project-URL: Homepage, https://github.com/agiopen-org/oagi
-Author-email: OpenAGI Foundation <contact@agiopen.org>
-License: MIT License
-        
-        Copyright (c) 2025 OpenAGI Foundation
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-Requires-Python: >=3.10
-Requires-Dist: httpx>=0.28.0
-Requires-Dist: pillow>=11.3.0
-Requires-Dist: pyautogui>=0.9.54
-Requires-Dist: pydantic>=2.0.0
-Description-Content-Type: text/markdown
-
-# OAGI Python SDK
-
-## Basic Usage
-```bash
-pip install oagi # python >= 3.10
-```
-```bash
-export OAGI_BASE_URL=""
-export OAGI_API_KEY="sk-xxxx"
-```
-
-```python
-from oagi import PyautoguiActionHandler, ScreenshotMaker, ShortTask
-short_task = ShortTask()
-is_completed = short_task.auto_mode(
-    "Search weather with Google",
-    max_steps=5,
-    executor=PyautoguiActionHandler(),
-    image_provider=(sm := ScreenshotMaker()),
-)
-```

oagi-0.2.1.dist-info/RECORD

@@ -1,20 +0,0 @@
-oagi/__init__.py,sha256=ms9ahLdHNrMWtiqX93q8Iv55ag__tO4Id0DQ3hA2TVM,1347
-oagi/exceptions.py,sha256=VMwVS8ouE9nHhBpN3AZMYt5_U2kGcihWaTnBhoQLquo,1662
-oagi/logging.py,sha256=CWe89mA5MKTipIvfrqSYkv2CAFNBSwHMDQMDkG_g64g,1350
-oagi/pyautogui_action_handler.py,sha256=LBWmtqkXzZSJo07s3uOw-NWUE9rZZtbNAx0YI83pCbk,5482
-oagi/screenshot_maker.py,sha256=lyJSMFagHeaqg59CQGMTqLvSzQN_pBbhbV2oIFG46vA,2077
-oagi/short_task.py,sha256=ofcMi7vbu9W1MCSGOk_FNEHJcB02pfgNcx1-Y8UkpJY,1552
-oagi/single_step.py,sha256=JEsF7ABa4wwW5Pi5AfjeKzyuKhC4kC4fcotnmnNye5o,2874
-oagi/sync_client.py,sha256=E6EgFIe-H91rdsPhF1puwrBTpOnKaL6JA1WHR4R-CLY,9395
-oagi/task.py,sha256=NmpNMu8CJll50zGsGtVie1kdpKeWnAAWudEa-aasBbU,3959
-oagi/types/__init__.py,sha256=eh-1IEqMTY2hUrvQJeTg6vsvlE6F4Iz5C0_K86AnWn8,549
-oagi/types/action_handler.py,sha256=NH8E-m5qpGqWcXzTSWfF7W0Xdp8SkzJsbhCmQ0B96cg,1075
-oagi/types/image.py,sha256=KgPCCTJ6D5vHIaGZdbTE7eQEa1WlT6G9tf59ZuUCV2U,537
-oagi/types/image_provider.py,sha256=oYFdOYznrK_VOR9egzOjw5wFM5w8EY2sY01pH0ANAgU,1112
-oagi/types/models/__init__.py,sha256=4qhKxWXsXEVzD6U_RM6PXR45os765qigtZs1BsS4WHg,414
-oagi/types/models/action.py,sha256=8Xd3IcH32ENq7uXczo-mbQ736yUOGxO_TaZTfHVRY7w,935
-oagi/types/models/step.py,sha256=RSI4H_2rrUBq_xyCoWKaq7JHdJWNobtQppaKC1l0aWU,471
-oagi-0.2.1.dist-info/METADATA,sha256=5W_aB_J2LUEyKAvE6G_iOcySv7tf0PWiGikOQe_K7l4,2066
-oagi-0.2.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-oagi-0.2.1.dist-info/licenses/LICENSE,sha256=sy5DLA2M29jFT4UfWsuBF9BAr3FnRkYtnAu6oDZiIf8,1075
-oagi-0.2.1.dist-info/RECORD,,