arcade-google 1.2.4__tar.gz

arcade_google-1.2.4/.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-1.2.4/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+files: ^.*/google/.*
+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-1.2.4/.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-1.2.4/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-1.2.4/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-1.2.4/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: arcade_google
+Version: 1.2.4
+Summary: Arcade.dev LLM tools for Google Workspace
+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: beautifulsoup4<5.0.0,>=4.10.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-oauthlib<2.0.0,>=1.2.1
+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.0; 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-1.2.4/arcade_google/constants.py

@@ -0,0 +1,24 @@
+import os
+
+from arcade_google.models import GmailReplyToWhom
+
+# The default reply in Gmail is to only the sender. Since Gmail also offers the possibility of
+# changing the default to 'reply to all', we support both options through an env variable.
+# https://support.google.com/mail/answer/6585?hl=en&sjid=15399867888091633568-SA#null
+try:
+    GMAIL_DEFAULT_REPLY_TO = GmailReplyToWhom(
+        # Values accepted are defined in the arcade_google.tools.models.GmailReplyToWhom Enum
+        os.getenv("ARCADE_GMAIL_DEFAULT_REPLY_TO", GmailReplyToWhom.ONLY_THE_SENDER.value).lower()
+    )
+except ValueError as e:
+    raise ValueError(
+        "Invalid value for ARCADE_GMAIL_DEFAULT_REPLY_TO: "
+        f"'{os.getenv('ARCADE_GMAIL_DEFAULT_REPLY_TO')}'. Expected one of "
+        f"{list(GmailReplyToWhom.__members__.keys())}"
+    ) from e
+
+
+DEFAULT_SEARCH_CONTACTS_LIMIT = 30
+
+DEFAULT_SHEET_ROW_COUNT = 1000
+DEFAULT_SHEET_COLUMN_COUNT = 26

arcade_google-1.2.4/arcade_google/critics.py

@@ -0,0 +1,41 @@
+from collections.abc import Collection
+from typing import Any
+
+from arcade_evals import DatetimeCritic
+
+
+class DatetimeOrNoneCritic(DatetimeCritic):
+    """
+    A critic that evaluates the closeness of datetime values within a specified tolerance or whether
+    it's a None value.
+
+    Attributes:
+        tolerance: Acceptable timedelta between expected and actual datetimes.
+        max_difference: Maximum timedelta for a partial score.
+    """
+
+    def evaluate(self, expected: Any, actual: Any) -> dict[str, Any]:
+        if actual is None:
+            return {"match": True, "score": self.weight}
+        return super().evaluate(expected, actual)
+
+
+class AnyDatetimeCritic(DatetimeCritic):
+    """
+    A critic that evaluates the closeness of datetime values within a list of expected values.
+    """
+
+    def evaluate(self, expected: Any, actual: Any) -> dict[str, Any]:
+        if not isinstance(expected, Collection):
+            expected = [expected]
+        for expected_value in expected:
+            critic = DatetimeCritic(
+                critic_field=self.critic_field,
+                weight=self.weight,
+                tolerance=self.tolerance,
+                max_difference=self.max_difference,
+            )
+            result = critic.evaluate(expected_value, actual)
+            if result["match"]:
+                return result
+        return {"match": False, "score": 0}

arcade_google-1.2.4/arcade_google/doc_to_html.py

@@ -0,0 +1,99 @@
+def convert_document_to_html(document: dict) -> str:
+    html = (
+        "<html><head>"
+        f"<title>{document['title']}</title>"
+        f'<meta name="documentId" content="{document["documentId"]}">'
+        "</head><body>"
+    )
+    for element in document["body"]["content"]:
+        html += convert_structural_element(element)
+    html += "</body></html>"
+    return html
+
+
+def convert_structural_element(element: dict, wrap_paragraphs: bool = True) -> str:
+    if "sectionBreak" in element or "tableOfContents" in element:
+        return ""
+
+    elif "paragraph" in element:
+        paragraph_content = ""
+
+        prepend, append = get_paragraph_style_tags(
+            style=element["paragraph"]["paragraphStyle"],
+            wrap_paragraphs=wrap_paragraphs,
+        )
+
+        for item in element["paragraph"]["elements"]:
+            if "textRun" not in item:
+                continue
+            paragraph_content += extract_paragraph_content(item["textRun"])
+
+        if not paragraph_content:
+            return ""
+
+        return f"{prepend}{paragraph_content.strip()}{append}"
+
+    elif "table" in element:
+        table = [
+            [
+                "".join([
+                    convert_structural_element(element=cell_element, wrap_paragraphs=False)
+                    for cell_element in cell["content"]
+                ])
+                for cell in row["tableCells"]
+            ]
+            for row in element["table"]["tableRows"]
+        ]
+        return table_list_to_html(table)
+
+    else:
+        raise ValueError(f"Unknown document body element type: {element}")
+
+
+def extract_paragraph_content(text_run: dict) -> str:
+    content = text_run["content"]
+    style = text_run["textStyle"]
+    return apply_text_style(content, style)
+
+
+def apply_text_style(content: str, style: dict) -> str:
+    content = content.rstrip("\n")
+    content = content.replace("\n", "<br>")
+    italic = style.get("italic", False)
+    bold = style.get("bold", False)
+    if italic:
+        content = f"<i>{content}</i>"
+    if bold:
+        content = f"<b>{content}</b>"
+    return content
+
+
+def get_paragraph_style_tags(style: dict, wrap_paragraphs: bool = True) -> tuple[str, str]:
+    named_style = style["namedStyleType"]
+    if named_style == "NORMAL_TEXT":
+        return ("<p>", "</p>") if wrap_paragraphs else ("", "")
+    elif named_style == "TITLE":
+        return "<h1>", "</h1>"
+    elif named_style == "SUBTITLE":
+        return "<h2>", "</h2>"
+    elif named_style.startswith("HEADING_"):
+        try:
+            heading_level = int(named_style.split("_")[1])
+        except ValueError:
+            return ("<p>", "</p>") if wrap_paragraphs else ("", "")
+        else:
+            return f"<h{heading_level}>", f"</h{heading_level}>"
+    return ("<p>", "</p>") if wrap_paragraphs else ("", "")
+
+
+def table_list_to_html(table: list[list[str]]) -> str:
+    html = "<table>"
+    for row in table:
+        html += "<tr>"
+        for cell in row:
+            if cell.endswith("<br>"):
+                cell = cell[:-4]
+            html += f"<td>{cell}</td>"
+        html += "</tr>"
+    html += "</table>"
+    return html

arcade_google-1.2.4/arcade_google/doc_to_markdown.py

@@ -0,0 +1,64 @@
+import arcade_google.doc_to_html as doc_to_html
+
+
+def convert_document_to_markdown(document: dict) -> str:
+    md = f"---\ntitle: {document['title']}\ndocumentId: {document['documentId']}\n---\n"
+    for element in document["body"]["content"]:
+        md += convert_structural_element(element)
+    return md
+
+
+def convert_structural_element(element: dict) -> str:
+    if "sectionBreak" in element or "tableOfContents" in element:
+        return ""
+
+    elif "paragraph" in element:
+        md = ""
+        prepend = get_paragraph_style_prepend_str(element["paragraph"]["paragraphStyle"])
+        for item in element["paragraph"]["elements"]:
+            if "textRun" not in item:
+                continue
+            content = extract_paragraph_content(item["textRun"])
+            md += f"{prepend}{content}"
+        return md
+
+    elif "table" in element:
+        return doc_to_html.convert_structural_element(element)
+
+    else:
+        raise ValueError(f"Unknown document body element type: {element}")
+
+
+def extract_paragraph_content(text_run: dict) -> str:
+    content = text_run["content"]
+    style = text_run["textStyle"]
+    return apply_text_style(content, style)
+
+
+def apply_text_style(content: str, style: dict) -> str:
+    append = "\n" if content.endswith("\n") else ""
+    content = content.rstrip("\n")
+    italic = style.get("italic", False)
+    bold = style.get("bold", False)
+    if italic:
+        content = f"_{content}_"
+    if bold:
+        content = f"**{content}**"
+    return f"{content}{append}"
+
+
+def get_paragraph_style_prepend_str(style: dict) -> str:
+    named_style = style["namedStyleType"]
+    if named_style == "NORMAL_TEXT":
+        return ""
+    elif named_style == "TITLE":
+        return "# "
+    elif named_style == "SUBTITLE":
+        return "## "
+    elif named_style.startswith("HEADING_"):
+        try:
+            heading_level = int(named_style.split("_")[1])
+            return f"{'#' * heading_level} "
+        except ValueError:
+            return ""
+    return ""

arcade_google-1.2.4/arcade_google/exceptions.py

@@ -0,0 +1,70 @@
+from zoneinfo import available_timezones
+
+from arcade_tdk.errors import RetryableToolError
+
+
+class GoogleToolError(Exception):
+    """Base exception for Google tool errors."""
+
+    def __init__(self, message: str, developer_message: str | None = None):
+        self.message = message
+        self.developer_message = developer_message
+        super().__init__(self.message)
+
+    def __str__(self) -> str:
+        base_message = self.message
+        if self.developer_message:
+            return f"{base_message} (Developer: {self.developer_message})"
+        return base_message
+
+
+class RetryableGoogleToolError(RetryableToolError):
+    """Raised when there's an error in a Google tool that can be retried."""
+
+    pass
+
+
+class GoogleServiceError(GoogleToolError):
+    """Raised when there's an error building or using the Google service."""
+
+    pass
+
+
+class GmailToolError(GoogleToolError):
+    """Raised when there's an error in the Gmail tools."""
+
+    pass
+
+
+class GoogleCalendarToolError(GoogleToolError):
+    """Raised when there's an error in the Google Calendar tools."""
+
+    pass
+
+
+class InvalidTimezoneError(RetryableGoogleToolError):
+    """Raised when a timezone is provided that is not supported by Python's zoneinfo."""
+
+    def __init__(self, timezone_str: str):
+        self.timezone_str = timezone_str
+        available_timezones_msg = (
+            "Here is a list of valid timezones (from Python's zoneinfo.available_timezones()): "
+            f"{available_timezones()}"
+        )
+        super().__init__(
+            f"Invalid timezone: '{timezone_str}'",
+            developer_message=available_timezones_msg,
+            additional_prompt_content=available_timezones_msg,
+        )
+
+
+class GoogleDriveToolError(GoogleToolError):
+    """Raised when there's an error in the Google Drive tools."""
+
+    pass
+
+
+class GoogleDocsToolError(GoogleToolError):
+    """Raised when there's an error in the Google Docs tools."""
+
+    pass