arcade-google-sheets 2.0.0rc1__tar.gz

arcade_google_sheets-2.0.0rc1/.gitignore

@@ -0,0 +1,175 @@
+.DS_Store
+credentials.yaml
+docker/credentials.yaml
+
+*.lock
+
+# example data
+examples/data
+scratch
+
+
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/

arcade_google_sheets-2.0.0rc1/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+files: ^.*/google_sheets/.*
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

arcade_google_sheets-2.0.0rc1/.ruff.toml

@@ -0,0 +1,46 @@
+target-version = "py310"
+line-length = 100
+fix = true
+
+[lint]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+
+[lint.per-file-ignores]
+"*" = ["TRY003", "B904"]
+"**/tests/*" = ["S101", "E501"]
+"**/evals/*" = ["S101", "E501"]
+
+[format]
+preview = true
+skip-magic-trailing-comma = false

arcade_google_sheets-2.0.0rc1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Arcade
+
+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.

arcade_google_sheets-2.0.0rc1/Makefile

@@ -0,0 +1,55 @@
+.PHONY: help
+
+help:
+	@echo "🛠️ github Commands:\n"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Install the uv environment and install all packages with dependencies
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras --no-sources
+	@if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: install-local
+install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras
+	@if [ -f .pre-commit-config.yaml ]; then uv run pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: build
+build: clean-build ## Build wheel file using poetry
+	@echo "🚀 Creating wheel file"
+	uv build
+
+.PHONY: clean-build
+clean-build: ## clean build artifacts
+	@echo "🗑️ Cleaning dist directory"
+	rm -rf dist
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml
+
+.PHONY: coverage
+coverage: ## Generate coverage report
+	@echo "coverage report"
+	@uv run --no-sources coverage report
+	@echo "Generating coverage report"
+	@uv run --no-sources coverage html
+
+.PHONY: bump-version
+bump-version: ## Bump the version in the pyproject.toml file by a patch version
+	@echo "🚀 Bumping version in pyproject.toml"
+	uv version --no-sources --bump patch
+
+.PHONY: check
+check: ## Run code quality tools.
+	@if [ -f .pre-commit-config.yaml ]; then\
+		echo "🚀 Linting code: Running pre-commit";\
+		uv run --no-sources pre-commit run -a;\
+	fi
+	@echo "🚀 Static type checking: Running mypy"
+	@uv run --no-sources mypy --config-file=pyproject.toml

arcade_google_sheets-2.0.0rc1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: arcade_google_sheets
+Version: 2.0.0rc1
+Summary: Arcade.dev LLM tools for Google Sheets
+Author-email: Arcade <dev@arcade.dev>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: arcade-tdk<3.0.0,>=2.0.0
+Requires-Dist: google-api-core<3.0.0,>=2.19.1
+Requires-Dist: google-api-python-client<3.0.0,>=2.137.0
+Requires-Dist: google-auth-httplib2<1.0.0,>=0.2.0
+Requires-Dist: google-auth<3.0.0,>=2.32.0
+Requires-Dist: googleapis-common-protos<2.0.0,>=1.63.2
+Provides-Extra: dev
+Requires-Dist: arcade-ai[evals]<3.0.0,>=2.0.0rc1; extra == 'dev'
+Requires-Dist: arcade-serve<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: mypy<1.6.0,>=1.5.1; extra == 'dev'
+Requires-Dist: pre-commit<3.5.0,>=3.4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.25.0,>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov<4.1.0,>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock<3.12.0,>=3.11.1; extra == 'dev'
+Requires-Dist: pytest<8.4.0,>=8.3.0; extra == 'dev'
+Requires-Dist: ruff<0.8.0,>=0.7.4; extra == 'dev'
+Requires-Dist: tox<4.12.0,>=4.11.1; extra == 'dev'

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/__init__.py

@@ -0,0 +1,7 @@
+from arcade_google_sheets.tools import (
+    create_spreadsheet,
+    get_spreadsheet,
+    write_to_cell,
+)
+
+__all__ = ["create_spreadsheet", "get_spreadsheet", "write_to_cell"]

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/constants.py

@@ -0,0 +1,2 @@
+DEFAULT_SHEET_ROW_COUNT = 1000
+DEFAULT_SHEET_COLUMN_COUNT = 26

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/decorators.py

@@ -0,0 +1,24 @@
+import functools
+from collections.abc import Callable
+from typing import Any
+
+from arcade_tdk import ToolContext
+from googleapiclient.errors import HttpError
+
+from arcade_google_sheets.file_picker import generate_google_file_picker_url
+
+
+def with_filepicker_fallback(func: Callable[..., Any]) -> Callable[..., Any]:
+    """ """
+
+    @functools.wraps(func)
+    async def async_wrapper(context: ToolContext, *args: Any, **kwargs: Any) -> Any:
+        try:
+            return await func(context, *args, **kwargs)
+        except HttpError as e:
+            if e.status_code in [403, 404]:
+                file_picker_response = generate_google_file_picker_url(context)
+                return file_picker_response
+            raise
+
+    return async_wrapper

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/enums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class CellErrorType(str, Enum):
+    """The type of error in a cell
+
+    Implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ErrorType
+    """
+
+    ERROR_TYPE_UNSPECIFIED = "ERROR_TYPE_UNSPECIFIED"  # The default error type, do not use this.
+    ERROR = "ERROR"  # Corresponds to the #ERROR! error.
+    NULL_VALUE = "NULL_VALUE"  # Corresponds to the #NULL! error.
+    DIVIDE_BY_ZERO = "DIVIDE_BY_ZERO"  # Corresponds to the #DIV/0 error.
+    VALUE = "VALUE"  # Corresponds to the #VALUE! error.
+    REF = "REF"  # Corresponds to the #REF! error.
+    NAME = "NAME"  # Corresponds to the #NAME? error.
+    NUM = "NUM"  # Corresponds to the #NUM! error.
+    N_A = "N_A"  # Corresponds to the #N/A error.
+    LOADING = "LOADING"  # Corresponds to the Loading... state.
+
+
+class NumberFormatType(str, Enum):
+    NUMBER = "NUMBER"
+    PERCENT = "PERCENT"
+    CURRENCY = "CURRENCY"

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/file_picker.py

@@ -0,0 +1,49 @@
+import base64
+import json
+
+from arcade_tdk import ToolContext, ToolMetadataKey
+from arcade_tdk.errors import ToolExecutionError
+
+
+def generate_google_file_picker_url(context: ToolContext) -> dict:
+    """Generate a Google File Picker URL for user-driven file selection and authorization.
+
+    Generates a URL that directs the end-user to a Google File Picker interface where
+    where they can select or upload Google Drive files. Users can grant permission to access their
+    Drive files, providing a secure and authorized way to interact with their files.
+
+    This is particularly useful when prior tools (e.g., those accessing or modifying
+    Google Docs, Google Sheets, etc.) encountered failures due to file non-existence
+    (Requested entity was not found) or permission errors. Once the user completes the file
+    picker flow, the prior tool can be retried.
+
+    Returns:
+        A dictionary containing the URL and instructions for the llm to instruct the user.
+    """
+    client_id = context.get_metadata(ToolMetadataKey.CLIENT_ID)
+    client_id_parts = client_id.split("-")
+    if not client_id_parts:
+        raise ToolExecutionError(
+            message="Invalid Google Client ID",
+            developer_message=f"Google Client ID '{client_id}' is not valid",
+        )
+    app_id = client_id_parts[0]
+    cloud_coordinator_url = context.get_metadata(ToolMetadataKey.COORDINATOR_URL).strip("/")
+
+    config = {
+        "auth": {
+            "client_id": client_id,
+            "app_id": app_id,
+        },
+    }
+    config_json = json.dumps(config)
+    config_base64 = base64.urlsafe_b64encode(config_json.encode("utf-8")).decode("utf-8")
+    url = f"{cloud_coordinator_url}/google/drive_picker?config={config_base64}"
+
+    return {
+        "url": url,
+        "llm_instructions": (
+            "Instruct the user to click the following link to open the Google Drive File Picker. "
+            f"This will allow them to select files and grant access permissions: {url}"
+        ),
+    }

arcade_google_sheets-2.0.0rc1/arcade_google_sheets/models.py

@@ -0,0 +1,241 @@
+import json
+from typing import Optional
+
+from pydantic import BaseModel, field_validator, model_validator
+
+from arcade_google_sheets.enums import CellErrorType, NumberFormatType
+from arcade_google_sheets.types import CellValue
+
+
+class CellErrorValue(BaseModel):
+    """An error in a cell
+
+    Implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ErrorValue
+    """
+
+    type: CellErrorType
+    message: str
+
+
+class CellExtendedValue(BaseModel):
+    """The kinds of value that a cell in a spreadsheet can have
+
+    Implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ExtendedValue
+    """
+
+    numberValue: float | None = None
+    stringValue: str | None = None
+    boolValue: bool | None = None
+    formulaValue: str | None = None
+    errorValue: Optional["CellErrorValue"] = None
+
+    @model_validator(mode="after")
+    def check_exactly_one_value(cls, instance):  # type: ignore[no-untyped-def]
+        provided = [v for v in instance.__dict__.values() if v is not None]
+        if len(provided) != 1:
+            raise ValueError(
+                "Exactly one of numberValue, stringValue, boolValue, "
+                "formulaValue, or errorValue must be set."
+            )
+        return instance
+
+
+class NumberFormat(BaseModel):
+    """The format of a number
+
+    Implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#NumberFormat
+    """
+
+    pattern: str
+    type: NumberFormatType
+
+
+class CellFormat(BaseModel):
+    """The format of a cell
+
+    Partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#CellFormat
+    """
+
+    numberFormat: NumberFormat
+
+
+class CellData(BaseModel):
+    """Data about a specific cell
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#CellData
+    """
+
+    userEnteredValue: CellExtendedValue
+    userEnteredFormat: CellFormat | None = None
+
+
+class RowData(BaseModel):
+    """Data about each cellin a row
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#RowData
+    """
+
+    values: list[CellData]
+
+
+class GridData(BaseModel):
+    """Data in the grid
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#GridData
+    """
+
+    startRow: int
+    startColumn: int
+    rowData: list[RowData]
+
+
+class GridProperties(BaseModel):
+    """Properties of a grid
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#GridProperties
+    """
+
+    rowCount: int
+    columnCount: int
+
+
+class SheetProperties(BaseModel):
+    """Properties of a Sheet
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetProperties
+    """
+
+    sheetId: int
+    title: str
+    gridProperties: GridProperties | None = None
+
+
+class Sheet(BaseModel):
+    """A Sheet in a spreadsheet
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#Sheet
+    """
+
+    properties: SheetProperties
+    data: list[GridData] | None = None
+
+
+class SpreadsheetProperties(BaseModel):
+    """Properties of a spreadsheet
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#SpreadsheetProperties
+    """
+
+    title: str
+
+
+class Spreadsheet(BaseModel):
+    """A spreadsheet
+
+    A partial implementation of https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets
+    """
+
+    properties: SpreadsheetProperties
+    sheets: list[Sheet]
+
+
+class SheetDataInput(BaseModel):
+    """
+    SheetDataInput models the cell data of a spreadsheet in a custom format.
+
+    It is a dictionary mapping row numbers (as ints) to dictionaries that map
+    column letters (as uppercase strings) to cell values (int, float, str, or bool).
+
+    This model enforces that:
+      - The outer keys are convertible to int.
+      - The inner keys are alphabetic strings (normalized to uppercase).
+      - All cell values are only of type int, float, str, or bool.
+
+    The model automatically serializes (via `json_data()`)
+    and validates the inner types.
+    """
+
+    data: dict[int, dict[str, CellValue]]
+
+    @classmethod
+    def _parse_json_if_string(cls, value):  # type: ignore[no-untyped-def]
+        """Parses the value if it is a JSON string, otherwise returns it.
+
+        Helper method for when validating the `data` field.
+        """
+        if isinstance(value, str):
+            try:
+                return json.loads(value)
+            except json.JSONDecodeError as e:
+                raise TypeError(f"Invalid JSON: {e}")
+        return value
+
+    @classmethod
+    def _validate_row_key(cls, row_key) -> int:  # type: ignore[no-untyped-def]
+        """Converts the row key to an integer, raising an error if conversion fails.
+
+        Helper method for when validating the `data` field.
+        """
+        try:
+            return int(row_key)
+        except (ValueError, TypeError):
+            raise TypeError(f"Row key '{row_key}' is not convertible to int.")
+
+    @classmethod
+    def _validate_inner_cells(cls, cells, row_int: int) -> dict:  # type: ignore[no-untyped-def]
+        """Validates that 'cells' is a dict mapping column letters to valid cell values
+        and normalizes the keys.
+
+        Helper method for when validating the `data` field.
+        """
+        if not isinstance(cells, dict):
+            raise TypeError(
+                f"Value for row '{row_int}' must be a dict mapping column letters to cell values."
+            )
+        new_inner = {}
+        for col_key, cell_value in cells.items():
+            if not isinstance(col_key, str):
+                raise TypeError(f"Column key '{col_key}' must be a string.")
+            col_string = col_key.upper()
+            if not col_string.isalpha():
+                raise TypeError(f"Column key '{col_key}' is invalid. Must be alphabetic.")
+            if not isinstance(cell_value, int | float | str | bool):
+                raise TypeError(
+                    f"Cell value for {col_string}{row_int} must be an int, float, str, or bool."
+                )
+            new_inner[col_string] = cell_value
+        return new_inner
+
+    @field_validator("data", mode="before")
+    @classmethod
+    def validate_and_convert_keys(cls, value):  # type: ignore[no-untyped-def]
+        """
+        Validates data when SheetDataInput is instantiated and converts it to the correct format.
+        Uses private helper methods to parse JSON, validate row keys, and validate inner cell data.
+        """
+        if value is None:
+            return {}
+
+        value = cls._parse_json_if_string(value)
+        if isinstance(value, dict):
+            new_value = {}
+            for row_key, cells in value.items():
+                row_int = cls._validate_row_key(row_key)
+                inner_cells = cls._validate_inner_cells(cells, row_int)
+                new_value[row_int] = inner_cells
+            return new_value
+
+        raise TypeError("data must be a dict or a valid JSON string representing a dict")
+
+    def json_data(self) -> str:
+        """
+        Serialize the sheet data to a JSON string.
+        """
+        return json.dumps(self.data)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> "SheetDataInput":
+        """
+        Create a SheetData instance from a JSON string.
+        """
+        return cls.model_validate_json(json_str)