oagi-core 0.9.0__tar.gz

oagi_core-0.9.0/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        run: make install
+
+      - name: Run lint
+        run: make lint
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      - run: make install
+      - run: make build-all
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb
+      
+      - run: make install
+      
+      - name: Run tests with virtual display
+        run: xvfb-run -a make test-verbose

oagi_core-0.9.0/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # For trusted publishing
+      contents: write  # For GitHub release
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      
+      - name: Set up Python
+        run: uv python install 3.12
+      
+      - name: Build both packages
+        run: make build-all
+
+      - name: Publish oagi-core to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: dist/
+          # Another option: Use Trusted Publishing (recommended, no token needed)
+          # Configure at: https://pypi.org/manage/project/oagi-core/settings/publishing/
+
+      - name: Publish oagi metapackage to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: metapackage/dist/
+          # Another option: Use Trusted Publishing (recommended, no token needed)
+          # Configure at: https://pypi.org/manage/project/oagi/settings/publishing/
+
+      - name: Get commit message
+        id: commit_message
+        run: |
+          # Get the commit message for the tagged commit
+          echo "message<<EOF" >> $GITHUB_OUTPUT
+          git log -1 --pretty=%B >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body: ${{ steps.commit_message.outputs.message }}
+          files: |
+            dist/*
+            metapackage/dist/*

oagi_core-0.9.0/.gitignore

@@ -0,0 +1,212 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Metapackage synced files (copied from root)
+metapackage/README.md
+metapackage/LICENSE

oagi_core-0.9.0/.python-version

@@ -0,0 +1 @@
+3.10.18

oagi_core-0.9.0/CONTRIBUTING.md

@@ -0,0 +1 @@
+## Development

oagi_core-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+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.

oagi_core-0.9.0/Makefile

@@ -0,0 +1,57 @@
+.PHONY: .uv
+.uv:
+	@uv -V || echo 'Please install uv: https://docs.astral.sh/uv/getting-started/installation/'
+
+.PHONY: install-dev
+install-dev: .uv
+	uv sync --all-groups --all-extras
+
+.PHONY: install
+install: install-dev
+
+.PHONY: format
+format: .uv
+	uv run ruff check --fix
+	uv run ruff format
+
+.PHONY: lint
+lint: .uv
+	uv run ruff check
+	uv run ruff format --check
+
+.PHONY: build
+build: .uv
+	uv build
+
+.PHONY: sync-metapackage-files
+sync-metapackage-files:
+	@echo "Syncing README.md and LICENSE to metapackage..."
+	@cp README.md metapackage/README.md
+	@cp LICENSE metapackage/LICENSE
+
+.PHONY: build-metapackage
+build-metapackage: .uv sync-metapackage-files
+	cd metapackage && uv build
+
+.PHONY: build-all
+build-all: build build-metapackage
+
+.PHONY: test
+test: .uv install-dev
+	uv run pytest
+
+.PHONY: test-verbose
+test-verbose: .uv install-dev
+	uv run pytest -v
+
+.PHONY: version
+version:
+	@if [ -z "$(VERSION)" ]; then \
+		echo "Usage: make version VERSION=x.y.z"; \
+		echo "Current version: $$(grep '^version = ' pyproject.toml | head -1 | cut -d'"' -f2)"; \
+		exit 1; \
+	fi
+	@echo "Updating version to $(VERSION) in all files..."
+	@sed -i '' 's/^version = ".*"/version = "$(VERSION)"/' pyproject.toml
+	@sed -i '' 's/^version = ".*"/version = "$(VERSION)"/' metapackage/pyproject.toml
+	@sed -i '' 's/oagi-core\[desktop,server\]==.*/oagi-core[desktop,server]==$(VERSION)",/' metapackage/pyproject.toml

oagi_core-0.9.0/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.3
+Name: oagi-core
+Version: 0.9.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: pydantic>=2.0.0
+Provides-Extra: desktop
+Requires-Dist: pillow>=11.3.0; extra == 'desktop'
+Requires-Dist: pyautogui>=0.9.54; extra == 'desktop'
+Provides-Extra: server
+Requires-Dist: fastapi[standard]>=0.115.0; extra == 'server'
+Requires-Dist: pydantic-settings>=2.0.0; extra == 'server'
+Requires-Dist: python-socketio>=5.11.0; extra == 'server'
+Requires-Dist: uvicorn[standard]>=0.32.0; extra == 'server'
+Description-Content-Type: text/markdown
+
+# OAGI Python SDK
+
+Python SDK for the OAGI API - vision-based task automation.
+
+## Installation
+
+```bash
+# Recommended: All features (desktop automation + server)
+pip install oagi
+
+# Or install core only (minimal dependencies)
+pip install oagi-core
+
+# Or install with specific features
+pip install oagi-core[desktop]  # Desktop automation support
+pip install oagi-core[server]   # Server support
+```
+
+**Requires Python >= 3.10**
+
+### Installation Options
+
+- **`oagi`** (Recommended): Metapackage that includes all features (desktop + server). Equivalent to `oagi-core[desktop,server]`.
+- **`oagi-core`**: Core SDK with minimal dependencies (httpx, pydantic). Suitable for server deployments or custom automation setups.
+- **`oagi-core[desktop]`**: Adds `pyautogui` and `pillow` for desktop automation features like screenshot capture and GUI control.
+- **`oagi-core[server]`**: Adds FastAPI and Socket.IO dependencies for running the real-time server for browser extensions.
+
+**Note**: Features requiring desktop dependencies (like `PILImage.from_screenshot()`, `PyautoguiActionHandler`, `ScreenshotMaker`) will show helpful error messages if you try to use them without installing the `desktop` extra.
+
+## 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
+)
+```
+
+Configure PyAutoGUI behavior with custom settings:
+
+```python
+from oagi import PyautoguiActionHandler, PyautoguiConfig
+
+# Customize action behavior
+config = PyautoguiConfig(
+    drag_duration=1.0,      # Slower drags for precision (default: 0.5)
+    scroll_amount=50,       # Larger scroll steps (default: 30)
+    wait_duration=2.0,      # Longer waits (default: 1.0)
+    action_pause=0.2,       # More pause between actions (default: 0.1)
+    hotkey_interval=0.1,    # Interval between keys in hotkey combinations (default: 0.1)
+    capslock_mode="session" # Caps lock mode: 'session' or 'system' (default: 'session')
+)
+
+executor = PyautoguiActionHandler(config=config)
+task.auto_mode("Complete form", executor=executor, image_provider=ScreenshotMaker())
+```
+
+### 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)
+```
+
+### Async Support
+
+Use async client for non-blocking operations and better concurrency:
+
+```python
+import asyncio
+from oagi import async_single_step, AsyncShortTask
+
+async def main():
+    # Single-step async analysis
+    step = await async_single_step(
+        "Find the search bar",
+        screenshot="screenshot.png"
+    )
+    print(f"Found {len(step.actions)} actions")
+    
+    # Async task automation
+    task = AsyncShortTask()
+    async with task:
+        await task.init_task("Complete the form")
+        # ... continue with async operations
+
+asyncio.run(main())
+```
+
+## 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
+- `socketio_server_basic.py` - Socket.IO server example
+- `socketio_client_example.py` - Socket.IO client implementation
+
+## Socket.IO Server (Optional)
+
+The SDK includes an optional Socket.IO server for real-time bidirectional communication with browser extensions or custom clients.
+
+### Installation
+
+```bash
+# Install with server support
+pip install oagi  # Includes server features
+# Or
+pip install oagi-core[server]  # Core + server only
+```
+
+### Running the Server
+
+```python
+import uvicorn
+from oagi.server import create_app, ServerConfig
+
+# Create FastAPI app with Socket.IO
+app = create_app()
+
+# Run server
+uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+Or use the example script:
+```bash
+export OAGI_API_KEY="your-api-key"
+python examples/socketio_server_basic.py
+```
+
+### Server Features
+
+- **Dynamic namespaces**: Each session gets its own namespace (`/session/{session_id}`)
+- **Simplified events**: Single `init` event from client with instruction
+- **Action execution**: Emit individual actions (click, type, scroll, etc.) to client
+- **S3 integration**: Server sends presigned URLs for direct screenshot uploads
+- **Session management**: In-memory session storage with timeout cleanup
+- **REST API**: Health checks and session management endpoints
+
+### Client Integration
+
+Clients connect to a session namespace and handle action events:
+
+```python
+import socketio
+
+sio = socketio.AsyncClient()
+namespace = "/session/my_session_id"
+
+@sio.on("request_screenshot", namespace=namespace)
+async def on_screenshot(data):
+    # Upload screenshot to S3 using presigned URL
+    return {"success": True}
+
+@sio.on("click", namespace=namespace)
+async def on_click(data):
+    # Execute click at coordinates
+    return {"success": True}
+
+await sio.connect("http://localhost:8000", namespaces=[namespace])
+await sio.emit("init", {"instruction": "Click the button"}, namespace=namespace)
+```
+
+See [`examples/socketio_client_example.py`](examples/socketio_client_example.py) for a complete implementation.
+
+## Documentation
+
+
+## License
+
+MIT