arcade-google-docs 3.0.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

arcade_google_docs/__init__.py

@@ -1,8 +1,10 @@
 from arcade_google_docs.tools import (
+    comment_on_document,
     create_blank_document,
     create_document_from_text,
     get_document_by_id,
     insert_text_at_end_of_document,
+    list_document_comments,
     search_and_retrieve_documents,
     search_documents,
 )
@@ -10,6 +12,8 @@ from arcade_google_docs.tools import (
 __all__ = [
     "create_blank_document",
     "create_document_from_text",
+    "comment_on_document",
+    "list_document_comments",
     "get_document_by_id",
     "insert_text_at_end_of_document",
     "search_and_retrieve_documents",

arcade_google_docs/tools/__init__.py

@@ -1,3 +1,7 @@
+from arcade_google_docs.tools.comment import (
+    comment_on_document,
+    list_document_comments,
+)
 from arcade_google_docs.tools.create import (
     create_blank_document,
     create_document_from_text,
@@ -13,6 +17,8 @@ __all__ = [
     "create_blank_document",
     "create_document_from_text",
     "get_document_by_id",
+    "comment_on_document",
+    "list_document_comments",
     "insert_text_at_end_of_document",
     "search_and_retrieve_documents",
     "search_documents",

arcade_google_docs/tools/comment.py

@@ -0,0 +1,98 @@
+from typing import Annotated
+
+from arcade_tdk import ToolContext, tool
+from arcade_tdk.auth import Google
+
+from arcade_google_docs.utils import build_drive_service
+
+
+@tool(
+    requires_auth=Google(
+        scopes=[
+            "https://www.googleapis.com/auth/drive.file",
+        ],
+    )
+)
+async def comment_on_document(
+    context: ToolContext,
+    document_id: Annotated[str, "The ID of the document to comment on"],
+    comment_text: Annotated[str, "The comment to add to the document"],
+) -> Annotated[dict, "The comment's ID, documentId, and documentUrl in a dictionary"]:
+    """
+    Comment on a specific document by its ID.
+    """
+    drive_service = build_drive_service(context.get_auth_token_or_empty())
+
+    response = (
+        drive_service.comments()
+        .create(
+            fileId=document_id,
+            body={
+                "content": comment_text,
+            },
+            fields="id",
+        )
+        .execute()
+    )
+
+    return {
+        "comment_id": response["id"],
+        "document_url": f"https://docs.google.com/document/d/{document_id}",
+    }
+
+
+@tool(
+    requires_auth=Google(
+        scopes=[
+            "https://www.googleapis.com/auth/drive.file",
+        ],
+    )
+)
+async def list_document_comments(
+    context: ToolContext,
+    document_id: Annotated[str, "The ID of the document to list comments for"],
+    include_deleted: Annotated[
+        bool,
+        "Whether to include deleted comments in the results. Defaults to False.",
+    ] = False,
+) -> Annotated[
+    dict,
+    "A dictionary containing the comments",
+]:
+    """
+    List all comments on the specified Google Docs document.
+    """
+    drive_service = build_drive_service(context.get_auth_token_or_empty())
+
+    comments: list[dict] = []
+    params: dict = {
+        "fileId": document_id,
+        "pageSize": 100,
+        "fields": (
+            "nextPageToken,comments(id,content,createdTime,modifiedTime,deleted,"
+            "author(displayName,emailAddress),replies(id,content,createdTime,modifiedTime,deleted,author(displayName,emailAddress)))"
+        ),
+    }
+    if include_deleted:
+        params["includeDeleted"] = True
+
+    while True:
+        results = drive_service.comments().list(**params).execute()
+        batch = results.get("comments", [])
+        comments.extend(batch)
+        next_page_token = results.get("nextPageToken")
+        if not next_page_token:
+            break
+        params["pageToken"] = next_page_token
+
+    reply_count = 0
+    for comment in comments:
+        reply_count += len(comment.get("replies", []))
+
+    return {
+        "comments_count": len(comments),
+        "replies_count": reply_count,
+        "total_discussion_count": len(comments) + reply_count,
+        "comments": comments,
+        "document_url": f"https://docs.google.com/document/d/{document_id}",
+    }

arcade_google_docs/tools/search.py

@@ -55,7 +55,9 @@ async def search_documents(
     ] = False,
     order_by: Annotated[
         list[OrderBy] | None,
-        "Sort order. Defaults to listing the most recently modified documents first",
+        "Sort order. Defaults to listing the most recently modified documents first. If "
+        "document_contains or document_not_contains is provided, "
+        "then the order_by will be ignored.",
     ] = None,
     limit: Annotated[int, "The number of documents to list"] = 50,
     pagination_token: Annotated[
@@ -69,7 +71,12 @@ async def search_documents(
     """
     Searches for documents in the user's Google Drive. Excludes documents that are in the trash.
     """
-    if order_by is None:
+    if document_contains or document_not_contains:
+        # Google drive API does not support other order_by values for
+        # queries with fullText search (which is used when document_contains
+        # or document_not_contains is provided).
+        order_by = None
+    elif order_by is None:
         order_by = [OrderBy.MODIFIED_TIME_DESC]
     elif isinstance(order_by, OrderBy):
         order_by = [order_by]

arcade_google_docs/utils.py

@@ -34,7 +34,7 @@ def build_drive_service(auth_token: str | None) -> Resource:  # type: ignore[no-
 def build_files_list_params(
     mime_type: str,
     page_size: int,
-    order_by: list[OrderBy],
+    order_by: list[OrderBy] | None,
     pagination_token: str | None,
     include_shared_drives: bool,
     search_only_in_shared_drive_id: str | None,
@@ -51,7 +51,7 @@ def build_files_list_params(
     params = {
         "q": query,
         "pageSize": page_size,
-        "orderBy": ",".join([item.value for item in order_by]),
+        "orderBy": ",".join([item.value for item in order_by]) if order_by else None,
         "pageToken": pagination_token,
     }
 
@@ -102,8 +102,8 @@ def build_files_list_query(
             name_not_contains = keyword.replace("'", "\\'")
             full_text_not_contains = keyword.replace("'", "\\'")
             keyword_query = (
-                f"(name not contains '{name_not_contains}' and "
-                f"fullText not contains '{full_text_not_contains}')"
+                f"(not (name contains '{name_not_contains}' or "
+                f"fullText contains '{full_text_not_contains}'))"
             )
             query.append(keyword_query)
 

{arcade_google_docs-3.0.0.dist-info → arcade_google_docs-3.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arcade_google_docs
-Version: 3.0.0
+Version: 3.1.1
 Summary: Arcade.dev LLM tools for Google Docs
 Author-email: Arcade <dev@arcade.dev>
 License: Proprietary - Arcade Software License Agreement v1.0

{arcade_google_docs-3.0.0.dist-info → arcade_google_docs-3.1.1.dist-info}/RECORD

@@ -1,16 +1,17 @@
-arcade_google_docs/__init__.py,sha256=WxIJBwkBmVeHfvgQ9E8eZy28SVqSkBlbZPhgFWhVd7o,418
+arcade_google_docs/__init__.py,sha256=J3c3lEuqb86UE5zScpv7Gd4TltmzTUq_tWyA2Ff0gmI,528
 arcade_google_docs/decorators.py,sha256=5ONZ3vS2lZBmog5c1TcuWjyPDeftBPAJ7vXyLjSPFRk,751
 arcade_google_docs/doc_to_html.py,sha256=6RTpzRSrazNa6AndLZhA20wgVDzZuHUqpu3WAkAsbjQ,3146
 arcade_google_docs/doc_to_markdown.py,sha256=eT-sc6ruxN8nEtUm9mBHFOWXajEBTTXkxsn6XsLHIxo,2020
 arcade_google_docs/enum.py,sha256=vFJWPe1JPG6I9xqdVVvuaEeen4LvvtJxax1sDYeh4UU,3421
 arcade_google_docs/file_picker.py,sha256=kGfUVfH5QVlIW1sL-_gAwPokt7TwVEcPk3Vnk53GKUE,2005
 arcade_google_docs/templates.py,sha256=pxbdMj57eV3-ImW3CixDWscpVKS94Z8nTNyTxDhUfGY,283
-arcade_google_docs/utils.py,sha256=Eku4b1olLcXfQ20liE9m3iPWvy60VA62tQ8TFwRKn94,3722
-arcade_google_docs/tools/__init__.py,sha256=f0d7ZRXCqgODDBkKtNhvHzsqs_GuZ97fe0dpjBcXKq8,548
+arcade_google_docs/utils.py,sha256=XMgKcWPWKy8SbH3y2eCil01hssHhUgYxVrwXyvHEU4A,3748
+arcade_google_docs/tools/__init__.py,sha256=vtn_NKrYwgWsdgcDYBY4t8m_XF73jB4j7zrpt-NC-dI,707
+arcade_google_docs/tools/comment.py,sha256=Qm5NHdNHONs3j4gqbZ7Fw9NrTVBb_mZ-th1X-z2IoLM,2836
 arcade_google_docs/tools/create.py,sha256=AuYy8yMGscrxAdLJQX0WiisGHCTufSlaRu_QGMMKQmM,2764
 arcade_google_docs/tools/get.py,sha256=2wi9ZF9s_57mMbIGgsqr53Fr0AJyrYVOQ11x7nAyk8Y,1339
-arcade_google_docs/tools/search.py,sha256=_CaEs1A_qGToNPeuGQ2yN3phGtPD7fFQbW3UqZr_qpg,8617
+arcade_google_docs/tools/search.py,sha256=6wMacfbO3Pzxu30I-otaFIA5b9b9AKcIkgHr8M9QXLo,9007
 arcade_google_docs/tools/update.py,sha256=9SvffQIHnmYiEgyE1VrhXG2aHb0hIfWYPzPLc4nTdKI,2030
-arcade_google_docs-3.0.0.dist-info/METADATA,sha256=cO6YZ4UaKm2dqy0SNN1PVTIb7m0OCM1UcfHNFQaRal8,1097
-arcade_google_docs-3.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-arcade_google_docs-3.0.0.dist-info/RECORD,,
+arcade_google_docs-3.1.1.dist-info/METADATA,sha256=reKLvMCf-wM_GLIExvxUYXYUiCxYxoRXqN9vpiNa-24,1097
+arcade_google_docs-3.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+arcade_google_docs-3.1.1.dist-info/RECORD,,