oagi 0.0.0__tar.gz → 0.2.0__tar.gz

oagi-0.2.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
+
+  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-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+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 package
+        run: uv build
+      
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          # Another option: Use Trusted Publishing (recommended, no token needed)
+          # Configure at: https://pypi.org/manage/project/oagi/settings/publishing/
+          
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*
+          generate_release_notes: true

oagi-0.2.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# 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__/

oagi-0.2.0/.python-version

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

oagi-0.2.0/CONTRIBUTING.md

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

{oagi-0.0.0 → oagi-0.2.0}/LICENSE

@@ -1,21 +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.
+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-0.2.0/Makefile

@@ -0,0 +1,31 @@
+.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 --frozen --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
+
+build: .uv
+	uv build
+
+.PHONY: test
+test: .uv
+	uv run pytest
+
+.PHONY: test-verbose
+test-verbose: .uv
+	uv run pytest -v

{oagi-0.0.0 → oagi-0.2.0}/PKG-INFO

@@ -1,31 +1,55 @@
-Metadata-Version: 2.4
-Name: oagi
-Version: 0.0.0
-Summary: Official API of OpenAGI Foundation
-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.
-        
-Project-URL: Homepage, https://github.com/agiopen-org/oagi
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
+Metadata-Version: 2.3
+Name: oagi
+Version: 0.2.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
+
+## 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.0/README.md

@@ -0,0 +1,21 @@
+# 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.0/examples/execute_task_auto.py

@@ -0,0 +1,23 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+from oagi import PyautoguiActionHandler, ScreenshotMaker, ShortTask
+
+
+def execute_task_auto(task_desc, max_steps=5):
+    # set OAGI_API_KEY and OAGI_BASE_URL
+    # or ShortTask(api_key="your_api_key", base_url="your_base_url")
+    short_task = ShortTask()
+
+    is_completed = short_task.auto_mode(
+        task_desc,
+        max_steps=max_steps,
+        executor=PyautoguiActionHandler(),  # or executor = lambda actions: print(actions) for debugging
+        image_provider=(sm := ScreenshotMaker()),
+    )
+
+    return is_completed, sm.last_image()

oagi-0.2.0/examples/execute_task_manual.py

@@ -0,0 +1,48 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+
+from oagi import PyautoguiActionHandler, ScreenshotMaker, Task
+
+
+def execute_task_manual(task_desc, max_steps=5):
+    # set OAGI_API_KEY and OAGI_BASE_URL
+    # or ShortTask(api_key="your_api_key", base_url="your_base_url")
+    task = Task()
+    task.init_task(task_desc, max_steps=max_steps)
+    executor = (
+        PyautoguiActionHandler()
+    )  # executor = lambda actions: print(actions) for debugging
+    image_provider = ScreenshotMaker()
+
+    for i in range(max_steps):
+        # image can also be bytes
+        # with open("test_screenshot.png", "rb") as f:
+        #     image = f.read()
+        image = image_provider()
+
+        # For additional instructions
+        # step = task.step(image, instruction="some instruction")
+        step = task.step(image)
+
+        # do something with step, maybe print to debug
+        print(f"Step {i}: {step.reason=}")
+
+        if step.stop:
+            print(f"Task completed after {i} steps.")
+            is_completed = True
+            screenshot = image_provider.last_image()
+            break
+
+        executor(step.actions)
+    else:
+        # If we didn't break out of the loop, we used up all our steps
+        is_completed = False
+        screenshot = image_provider()
+
+    print(f"manual execution completed: {is_completed=}, {task_desc=}\n")
+    return is_completed, screenshot

oagi-0.2.0/examples/google_weather.py

@@ -0,0 +1,15 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+
+from examples.execute_task_manual import execute_task_manual
+
+is_completed, screenshot = execute_task_manual(
+    desc := "Search weather with Google", max_steps=5
+)
+
+print(f"is_completed: {is_completed}, desc: {desc}")

oagi-0.2.0/examples/hotel_booking.py

@@ -0,0 +1,52 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+from datetime import date
+
+from examples.execute_task_auto import execute_task_auto
+from examples.execute_task_manual import execute_task_manual
+
+
+def get_date():
+    today = date.today()
+    # move to first day of this month
+    first_day_this_month = today.replace(day=1)
+    # move to first day of next month
+    if first_day_this_month.month == 12:
+        first_day_next_month = first_day_this_month.replace(
+            year=first_day_this_month.year + 1, month=1
+        )
+    else:
+        first_day_next_month = first_day_this_month.replace(
+            month=first_day_this_month.month + 1
+        )
+
+    start_date = str(first_day_this_month)
+    end_date = str(first_day_next_month.replace(day=3))
+    return start_date, end_date
+
+
+def main():
+    """Task decomposition
+    1. Go to expedia.com
+    2. Click where to and enter Foster City
+    3. Click dates and click start date
+    4. Click end date and hit search
+    """
+    start_date, end_date = get_date()
+
+    is_completed, screenshot = execute_task_auto(desc := "Go to expedia.com")
+    print(f"auto execution completed: {is_completed=}, {desc=}\n")
+
+    execute_task = execute_task_manual  # or execute_task_auto
+    execute_task("Click where to and enter Foster City")
+    execute_task(f"Click dates and click {start_date}")
+    execute_task(f"Click {end_date} and hit search")
+
+
+if __name__ == "__main__":
+    main()

oagi-0.2.0/examples/single_step.py

@@ -0,0 +1,19 @@
+# -----------------------------------------------------------------------------
+#  Copyright (c) OpenAGI Foundation
+#  All rights reserved.
+#
+#  This file is part of the official API project.
+#  Licensed under the MIT License.
+# -----------------------------------------------------------------------------
+
+from oagi import single_step
+
+step = single_step(
+    task_description="Search weather with Google",
+    screenshot="some/path/to/local/image",  # bytes or Path object or Image object
+    instruction="The operating system is macos",  # optional instruction
+    # api_key="your-api-key", if not set with OAGI_API_KEY env var
+    # base_url="https://api.example.com" if not set with OAGI_BASE_URL env var
+)
+
+print(step)

oagi-0.2.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling==1.26.3", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "oagi"
+version = "0.2.0"
+description = "Official API of OpenAGI Foundation"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+  { name = "OpenAGI Foundation", email = "contact@agiopen.org" }
+]
+
+requires-python = ">= 3.10"
+
+dependencies = [
+    "httpx>=0.28.0",
+    "pillow>=11.3.0",
+    "pyautogui>=0.9.54",
+    "pydantic>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/agiopen-org/oagi"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.12.9",
+    "pytest>=8.0.0",
+    "pytest-mock>=3.12.0",
+]
+
+[tool.ruff.lint]
+extend-select = ["I", "PLC0415"]