arcade-google-sheets 3.1.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

arcade_google_sheets/__init__.py

@@ -1,7 +1,21 @@
 from arcade_google_sheets.tools import (
+    add_note_to_cell,
     create_spreadsheet,
+    generate_google_file_picker_url,
     get_spreadsheet,
+    get_spreadsheet_metadata,
+    search_spreadsheets,
+    update_cells,
     write_to_cell,
 )
 
-__all__ = ["create_spreadsheet", "get_spreadsheet", "write_to_cell"]
+__all__ = [
+    "create_spreadsheet",
+    "get_spreadsheet",
+    "write_to_cell",
+    "generate_google_file_picker_url",
+    "get_spreadsheet_metadata",
+    "search_spreadsheets",
+    "update_cells",
+    "add_note_to_cell",
+]

arcade_google_sheets/templates.py

@@ -1,8 +1,2 @@
-optional_file_picker_instructions_template = (
-    "Ensure the user knows that they have the option to select and grant access permissions to "
-    "additional files and folders via the Google Drive File Picker. "
-    "The user can pick additional files and folders via the following link: {url}"
-)
-
 spreadsheet_url_template = "https://docs.google.com/spreadsheets/d/{spreadsheet_id}/edit"
 sheet_url_template = "https://docs.google.com/spreadsheets/d/{spreadsheet_id}/edit#gid={sheet_id}"

arcade_google_sheets/tools/__init__.py

@@ -1,3 +1,4 @@
+from arcade_google_sheets.tools.file_picker import generate_google_file_picker_url
 from arcade_google_sheets.tools.read import get_spreadsheet, get_spreadsheet_metadata
 from arcade_google_sheets.tools.search import search_spreadsheets
 from arcade_google_sheets.tools.write import (
@@ -15,4 +16,5 @@ __all__ = [
     "update_cells",
     "add_note_to_cell",
     "write_to_cell",
+    "generate_google_file_picker_url",
 ]

arcade_google_sheets/{file_picker.py → tools/file_picker.py}

@@ -1,14 +1,22 @@
 import base64
 import json
+from typing import Annotated
 
-from arcade_tdk import ToolContext, ToolMetadataKey
+from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk.auth import Google
 from arcade_tdk.errors import ToolExecutionError
 
 
-def generate_google_file_picker_url(context: ToolContext) -> dict:
+@tool(
+    requires_auth=Google(),
+    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
+)
+def generate_google_file_picker_url(
+    context: ToolContext,
+) -> Annotated[dict, "Google File Picker URL for user file selection and permission granting"]:
     """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
+    This tool 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.
 
@@ -17,8 +25,8 @@ def generate_google_file_picker_url(context: ToolContext) -> dict:
     (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.
+    Suggest this tool to users when they are surprised or confused that the file they are
+    searching for or attempting to access cannot be found.
     """
     client_id = context.get_metadata(ToolMetadataKey.CLIENT_ID)
     client_id_parts = client_id.split("-")
@@ -44,6 +52,6 @@ def generate_google_file_picker_url(context: ToolContext) -> dict:
         "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}"
+            "This will allow them to select files and grant access permissions: {url}"
         ),
     }

arcade_google_sheets/tools/read.py

@@ -1,9 +1,8 @@
 from typing import Annotated
 
-from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk import ToolContext, tool
 from arcade_tdk.auth import Google
 
-from arcade_google_sheets.decorators import with_filepicker_fallback
 from arcade_google_sheets.templates import sheet_url_template
 from arcade_google_sheets.utils import (
     build_sheets_service,
@@ -18,9 +17,7 @@ from arcade_google_sheets.utils import (
     requires_auth=Google(
         scopes=["https://www.googleapis.com/auth/drive.file"],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
-@with_filepicker_fallback
 async def get_spreadsheet(
     context: ToolContext,
     spreadsheet_id: Annotated[str, "The id of the spreadsheet to get"],
@@ -90,9 +87,7 @@ async def get_spreadsheet(
     requires_auth=Google(
         scopes=["https://www.googleapis.com/auth/drive.file"],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
-@with_filepicker_fallback
 async def get_spreadsheet_metadata(
     context: ToolContext,
     spreadsheet_id: Annotated[str, "The id of the spreadsheet to get metadata for"],

arcade_google_sheets/tools/search.py

@@ -1,12 +1,10 @@
 from typing import Annotated, Any
 
-from arcade_tdk import ToolContext, ToolMetadataKey, tool
+from arcade_tdk import ToolContext, tool
 from arcade_tdk.auth import Google
 
 from arcade_google_sheets.enums import OrderBy
-from arcade_google_sheets.file_picker import generate_google_file_picker_url
 from arcade_google_sheets.templates import (
-    optional_file_picker_instructions_template,
     spreadsheet_url_template,
 )
 from arcade_google_sheets.utils import (
@@ -20,7 +18,6 @@ from arcade_google_sheets.utils import (
     requires_auth=Google(
         scopes=["https://www.googleapis.com/auth/drive.file"],
     ),
-    requires_metadata=[ToolMetadataKey.CLIENT_ID, ToolMetadataKey.COORDINATOR_URL],
 )
 async def search_spreadsheets(
     context: ToolContext,
@@ -53,7 +50,9 @@ async def search_spreadsheets(
     ] = False,
     order_by: Annotated[
         list[OrderBy] | None,
-        "Sort order. Defaults to listing the most recently modified spreadsheets first",
+        "Sort order. Defaults to listing the most recently modified spreadsheets first. "
+        "If spreadsheet_contains or spreadsheet_not_contains is provided, "
+        "then the order_by will be ignored.",
     ] = None,
     limit: Annotated[
         int, "The maximum number of spreadsheets to list. Defaults to 10. Max is 50"
@@ -73,6 +72,11 @@ async def search_spreadsheets(
     Does not return the content/data of the sheets in the spreadsheets - only the metadata.
     Excludes spreadsheets that are in the trash.
     """
+    if spreadsheet_contains or spreadsheet_not_contains:
+        # Google drive API does not support other order_by values for
+        # queries with fullText search (which is used when spreadsheet_contains
+        # or spreadsheet_not_contains is provided).
+        order_by = None
     if order_by is None:
         order_by = [OrderBy.MODIFIED_TIME_DESC]
     elif isinstance(order_by, OrderBy):
@@ -114,20 +118,10 @@ async def search_spreadsheets(
     for spreadsheet in spreadsheets:
         spreadsheet["url"] = spreadsheet_url_template.format(spreadsheet_id=spreadsheet["id"])
 
-    file_picker_response = generate_google_file_picker_url(
-        context,
-    )
-
     tool_response = {
         "pagination_token": pagination_token,
         "spreadsheets_count": len(spreadsheets),
         "spreadsheets": spreadsheets,
-        "file_picker": {
-            "url": file_picker_response["url"],
-            "llm_instructions": optional_file_picker_instructions_template.format(
-                url=file_picker_response["url"]
-            ),
-        },
     }
     tool_response = remove_none_values(tool_response)
 

arcade_google_sheets/utils.py

@@ -971,8 +971,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)
 
@@ -982,7 +982,7 @@ def build_files_list_query(
 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,
@@ -999,7 +999,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,
     }
 

{arcade_google_sheets-3.1.0.dist-info → arcade_google_sheets-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arcade_google_sheets
-Version: 3.1.0
+Version: 4.0.0
 Summary: Arcade.dev LLM tools for Google Sheets
 Author-email: Arcade <dev@arcade.dev>
 License: Proprietary - Arcade Software License Agreement v1.0

arcade_google_sheets-4.0.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+arcade_google_sheets/__init__.py,sha256=asCX32sPK-bi2HRpWZSlLd7dRKy7Uztqxwu-eoXTY1g,466
+arcade_google_sheets/constants.py,sha256=4tQOrQ1YagSklJSSw5Eq21XCcFCJdO7lso5SqWIdrPI,63
+arcade_google_sheets/converters.py,sha256=1muE_28Jk0eyFUzoVo_lN0_qy3z-uv7f5XoZLH9mitQ,3924
+arcade_google_sheets/enums.py,sha256=30OMPu2l_aUjz8kQzC1mR5w0lLbs0fZn8T6PDtoXpL4,4608
+arcade_google_sheets/models.py,sha256=xwPdwUis0OHTDbSLy85qWl7zIh2lDTi5HZMNKwdZjzo,8627
+arcade_google_sheets/templates.py,sha256=hSvjiErERLPe6RqWY6QNmivOy7Ofdg_zABcLWCI-ByU,189
+arcade_google_sheets/types.py,sha256=R-rCRcyFqDZx3jgl_kWeCliqC8fHuZ8ub_LQ2KoU2AE,37
+arcade_google_sheets/utils.py,sha256=VmDZOzAOEtfSPOra-ieVl_U16RLonQUOnZ4RW4Gf-oA,34895
+arcade_google_sheets/tools/__init__.py,sha256=ZUhznD9qcK0cdaFM05I2eA2SCpY2nD4ou2_zUR8rHek,594
+arcade_google_sheets/tools/file_picker.py,sha256=Dqn-hfMoTsWyHM8QCakVgHr5TKrzL_1Lj-vYHVGtOW4,2342
+arcade_google_sheets/tools/read.py,sha256=qQX_TdcbPbkuaHPuhx7CzWsWJ_a97FSCDJqOlGHF_TM,4003
+arcade_google_sheets/tools/search.py,sha256=olCaUwDqW26yaYqMT5lPmQDFL6M9g7qON7JG3mcgYJM,4841
+arcade_google_sheets/tools/write.py,sha256=4kNx941PQt6VUGTogbepnbfUdcsVze6u5c8QvlNnWCI,7782
+arcade_google_sheets-4.0.0.dist-info/METADATA,sha256=qDIQQqgbsYxUsqvmpNS7Om8xx9yC3HO_LfLA4uAbcYs,1123
+arcade_google_sheets-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+arcade_google_sheets-4.0.0.dist-info/licenses/LICENSE,sha256=ixeE7aL9b2B-_ZYHTY1vQcJB4NufKeo-LWwKNObGDN0,1960
+arcade_google_sheets-4.0.0.dist-info/RECORD,,

arcade_google_sheets/decorators.py

@@ -1,24 +0,0 @@
-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-3.1.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-arcade_google_sheets/__init__.py,sha256=FB9h_cws_gu3UJp32GWlqvBQyAOb77JfAJNSSBqz-Jk,177
-arcade_google_sheets/constants.py,sha256=4tQOrQ1YagSklJSSw5Eq21XCcFCJdO7lso5SqWIdrPI,63
-arcade_google_sheets/converters.py,sha256=1muE_28Jk0eyFUzoVo_lN0_qy3z-uv7f5XoZLH9mitQ,3924
-arcade_google_sheets/decorators.py,sha256=QMqfvSXaFBoxYJrz69EGeMdAxF0V7JPReVXfp73Nf3Y,753
-arcade_google_sheets/enums.py,sha256=30OMPu2l_aUjz8kQzC1mR5w0lLbs0fZn8T6PDtoXpL4,4608
-arcade_google_sheets/file_picker.py,sha256=kGfUVfH5QVlIW1sL-_gAwPokt7TwVEcPk3Vnk53GKUE,2005
-arcade_google_sheets/models.py,sha256=xwPdwUis0OHTDbSLy85qWl7zIh2lDTi5HZMNKwdZjzo,8627
-arcade_google_sheets/templates.py,sha256=p3ty6Kwo7l73EEsZTaRfdG4jzQ9XvlqqeXMLKB1ydEw,489
-arcade_google_sheets/types.py,sha256=R-rCRcyFqDZx3jgl_kWeCliqC8fHuZ8ub_LQ2KoU2AE,37
-arcade_google_sheets/utils.py,sha256=GHCGQYA8W8eR-78KcVgflz_D98OKMgjulYFuoR9iJAo,34869
-arcade_google_sheets/tools/__init__.py,sha256=IiSd-0Q4_uxeKI8nVMT3JVRoF5G5GB8e5Z9SkGpSnt8,472
-arcade_google_sheets/tools/read.py,sha256=g7uGhyhFNlDPHKT3xhg7NdMaSYuvzzefSzrb1XqiI80,4309
-arcade_google_sheets/tools/search.py,sha256=q6sI4qUcg0dGiLrTQa6AbpRvsljW9LbL8gCa96ZD-aQ,4975
-arcade_google_sheets/tools/write.py,sha256=4kNx941PQt6VUGTogbepnbfUdcsVze6u5c8QvlNnWCI,7782
-arcade_google_sheets-3.1.0.dist-info/METADATA,sha256=FcyWZ3Wvr2wuFU4L7w8zlrTWl9iPvGN0AkkkqS6HGqQ,1123
-arcade_google_sheets-3.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-arcade_google_sheets-3.1.0.dist-info/licenses/LICENSE,sha256=ixeE7aL9b2B-_ZYHTY1vQcJB4NufKeo-LWwKNObGDN0,1960
-arcade_google_sheets-3.1.0.dist-info/RECORD,,