arcade-x 0.1.5__py3-none-any.whl → 0.1.15__py3-none-any.whl

arcade_x/tools/constants.py

@@ -0,0 +1 @@
+TWEETS_URL = "https://api.x.com/2/tweets"

arcade_x/tools/tweets.py

@@ -1,20 +1,21 @@
 from typing import Annotated, Any
 
 import httpx
-from arcade.sdk import ToolContext, tool
-from arcade.sdk.auth import X
-from arcade.sdk.errors import RetryableToolError
+from arcade_tdk import ToolContext, tool
+from arcade_tdk.auth import X
+from arcade_tdk.errors import RetryableToolError
 
+from arcade_x.tools.constants import TWEETS_URL
 from arcade_x.tools.utils import (
+    expand_attached_media,
+    expand_long_tweet,
     expand_urls_in_tweets,
     get_headers_with_token,
     get_tweet_url,
     parse_search_recent_tweets_response,
+    remove_none_values,
 )
 
-TWEETS_URL = "https://api.x.com/2/tweets"
-
-
 # Manage Tweets Tools. See developer docs for additional available parameters:
 # https://developer.x.com/en/docs/x-api/tweets/manage-tweets/api-reference
 
@@ -63,21 +64,29 @@ async def search_recent_tweets_by_username(
     context: ToolContext,
     username: Annotated[str, "The username of the X (Twitter) user to look up"],
     max_results: Annotated[
-        int, "The maximum number of results to return. Cannot be less than 10"
+        int, "The maximum number of results to return. Must be in range [1, 100] inclusive"
     ] = 10,
+    next_token: Annotated[
+        str | None, "The pagination token starting from which to return results"
+    ] = None,
 ) -> Annotated[dict[str, Any], "Dictionary containing the search results"]:
     """Search for recent tweets (last 7 days) on X (Twitter) by username.
     Includes replies and reposts."""
 
     headers = get_headers_with_token(context)
-    params: dict[str, int | str] = {
+    params: dict[str, Any] = {
         "query": f"from:{username}",
-        "max_results": max(max_results, 10),  # X API does not allow 'max_results' less than 10
+        "max_results": min(
+            max(max_results, 10), 100
+        ),  # X API does not allow 'max_results' less than 10 or greater than 100
+        "next_token": next_token,
+        "expansions": "author_id",
+        "user.fields": "id,name,username,entities",
+        "tweet.fields": "entities,note_tweet",
     }
-    url = (
-        "https://api.x.com/2/tweets/search/recent?"
-        "expansions=author_id&user.fields=id,name,username,entities&tweet.fields=entities"
-    )
+    params = expand_attached_media(remove_none_values(params))
+
+    url = f"{TWEETS_URL}/search/recent"
 
     async with httpx.AsyncClient() as client:
         response = await client.get(url, headers=headers, params=params, timeout=10)
@@ -85,6 +94,9 @@ async def search_recent_tweets_by_username(
 
     response_data: dict[str, Any] = response.json()
 
+    for tweet in response_data.get("data", []):
+        expand_long_tweet(tweet)
+
     # Expand the URLs that are in the tweets
     response_data["data"] = expand_urls_in_tweets(
         response_data.get("data", []), delete_entities=True
@@ -106,8 +118,11 @@ async def search_recent_tweets_by_keywords(
         list[str] | None, "List of phrases that must be present in the tweet"
     ] = None,
     max_results: Annotated[
-        int, "The maximum number of results to return. Cannot be less than 10"
+        int, "The maximum number of results to return. Must be in range [1, 100] inclusive"
     ] = 10,
+    next_token: Annotated[
+        str | None, "The pagination token starting from which to return results"
+    ] = None,
 ) -> Annotated[dict[str, Any], "Dictionary containing the search results"]:
     """
     Search for recent tweets (last 7 days) on X (Twitter) by required keywords and phrases.
@@ -116,7 +131,7 @@ async def search_recent_tweets_by_keywords(
     """
 
     if not any([keywords, phrases]):
-        raise RetryableToolError(  # noqa: TRY003
+        raise RetryableToolError(
             "No keywords or phrases provided",
             developer_message="Predicted inputs didn't contain any keywords or phrases",
             additional_prompt_content="Please provide at least one keyword or phrase for search",
@@ -129,14 +144,19 @@ async def search_recent_tweets_by_keywords(
     if keywords:
         query += " ".join(keywords or [])
 
-    params: dict[str, int | str] = {
+    params: dict[str, Any] = {
         "query": query.strip(),
-        "max_results": max(max_results, 10),  # X API does not allow 'max_results' less than 10
+        "max_results": min(
+            max(max_results, 10), 100
+        ),  # X API does not allow 'max_results' less than 10 or greater than 100
+        "next_token": next_token,
+        "expansions": "author_id",
+        "user.fields": "id,name,username,entities",
+        "tweet.fields": "entities,note_tweet",
     }
-    url = (
-        "https://api.x.com/2/tweets/search/recent?"
-        "expansions=author_id&user.fields=id,name,username,entities&tweet.fields=entities"
-    )
+    params = expand_attached_media(remove_none_values(params))
+
+    url = f"{TWEETS_URL}/search/recent"
 
     async with httpx.AsyncClient() as client:
         response = await client.get(url, headers=headers, params=params, timeout=10)
@@ -144,6 +164,9 @@ async def search_recent_tweets_by_keywords(
 
     response_data: dict[str, Any] = response.json()
 
+    for tweet in response_data.get("data", []):
+        expand_long_tweet(tweet)
+
     # Expand the URLs that are in the tweets
     response_data["data"] = expand_urls_in_tweets(
         response_data.get("data", []), delete_entities=True
@@ -166,8 +189,10 @@ async def lookup_tweet_by_id(
     params = {
         "expansions": "author_id",
         "user.fields": "id,name,username,entities",
-        "tweet.fields": "entities",
+        "tweet.fields": "entities,note_tweet",
     }
+    params = expand_attached_media(params)
+
     url = f"{TWEETS_URL}/{tweet_id}"
 
     async with httpx.AsyncClient() as client:
@@ -179,6 +204,8 @@ async def lookup_tweet_by_id(
     # Get the tweet data
     tweet_data = response_data.get("data")
     if tweet_data:
+        expand_long_tweet(tweet_data)
+
         # Expand the URLs that are in the tweet
         expanded_tweet_list = expand_urls_in_tweets([tweet_data], delete_entities=True)
         response_data["data"] = expanded_tweet_list[0]

arcade_x/tools/users.py

@@ -1,9 +1,9 @@
 from typing import Annotated
 
 import httpx
-from arcade.sdk import ToolContext, tool
-from arcade.sdk.auth import X
-from arcade.sdk.errors import RetryableToolError
+from arcade_tdk import ToolContext, tool
+from arcade_tdk.auth import X
+from arcade_tdk.errors import RetryableToolError
 
 from arcade_x.tools.utils import (
     expand_urls_in_user_description,
@@ -48,7 +48,7 @@ async def lookup_single_user_by_username(
         response = await client.get(url, headers=headers, timeout=10)
         if response.status_code == 404:
             # User not found
-            raise RetryableToolError(  # noqa: TRY003
+            raise RetryableToolError(
                 "User not found",
                 developer_message=f"User with username '{username}' not found.",
                 additional_prompt_content="Please check the username and try again.",

arcade_x/tools/utils.py

@@ -1,7 +1,7 @@
 from typing import Any
 
-from arcade.sdk import ToolContext
-from arcade.sdk.errors import ToolExecutionError
+from arcade_tdk import ToolContext
+from arcade_tdk.errors import ToolExecutionError
 
 
 def get_tweet_url(tweet_id: str) -> str:
@@ -12,12 +12,15 @@ def get_tweet_url(tweet_id: str) -> str:
 def get_headers_with_token(context: ToolContext) -> dict[str, str]:
     """Get the headers for a request to the X API."""
     if context.authorization is None or context.authorization.token is None:
-        raise ToolExecutionError(  # noqa: TRY003
+        raise ToolExecutionError(
             "Missing Token. Authorization is required to post a tweet.",
             developer_message="Token is not set in the ToolContext.",
         )
+    token = (
+        context.authorization.token if context.authorization and context.authorization.token else ""
+    )
     return {
-        "Authorization": f"Bearer {context.authorization.token}",
+        "Authorization": f"Bearer {token}",
         "Content-Type": "application/json",
     }
 
@@ -28,14 +31,16 @@ def parse_search_recent_tweets_response(response_data: dict[str, Any]) -> dict[s
     Returns the modified response data with added 'tweet_url', 'author_username', and 'author_name'.
     """
     if not sanity_check_tweets_data(response_data):
-        return {"data": []}
+        return {"data": [], "next_token": ""}
 
     # Add 'tweet_url' to each tweet
     for tweet in response_data["data"]:
         tweet["tweet_url"] = get_tweet_url(tweet["id"])
 
     # Add 'author_username' and 'author_name' to each tweet
-    for tweet_data, user_data in zip(response_data["data"], response_data["includes"]["users"]):
+    for tweet_data, user_data in zip(
+        response_data["data"], response_data["includes"]["users"], strict=False
+    ):
         tweet_data["author_username"] = user_data["username"]
         tweet_data["author_name"] = user_data["name"]
 
@@ -55,6 +60,17 @@ def sanity_check_tweets_data(tweets_data: dict[str, Any]) -> bool:
     return True
 
 
+def expand_long_tweet(tweet_data: dict[str, Any]) -> None:
+    """Expand a long tweet.
+
+    For tweets exceeding 280 characters,
+    replace the truncated tweet text with the full tweet text.
+    """
+    if tweet_data.get("note_tweet"):
+        tweet_data["text"] = tweet_data["note_tweet"]["text"]
+        del tweet_data["note_tweet"]
+
+
 def expand_urls_in_tweets(
     tweets_data: list[dict[str, Any]], delete_entities: bool = True
 ) -> list[dict[str, Any]]:
@@ -110,3 +126,37 @@ def expand_urls_in_user_url(user_data: dict, delete_entities: bool = True) -> di
     if delete_entities:
         new_user_data.pop("entities", None)
     return new_user_data
+
+
+def remove_none_values(params: dict) -> dict:
+    """
+    Remove key/value pairs with None values from a dictionary.
+
+    Args:
+        params: The dictionary to clean
+
+    Returns:
+        A new dictionary with None values removed
+    """
+    return {k: v for k, v in params.items() if v is not None}
+
+
+def expand_attached_media(params: dict) -> dict:
+    """
+    Include attached media metadata in the request parameters.
+    """
+    params["expansions"] += ",attachments.media_keys"
+    params["tweet.fields"] += ",attachments"
+    params["media.fields"] = ",".join([
+        # media_key, url and type are returned by default, added here for clarity
+        "media_key",
+        "url",
+        "type",
+        "duration_ms",
+        "height",
+        "width",
+        "preview_image_url",
+        "alt_text",
+        "public_metrics",
+    ])
+    return params

arcade_x-0.1.15.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: arcade_x
+Version: 0.1.15
+Summary: Arcade.dev LLM tools for X (Twitter)
+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: httpx<1.0.0,>=0.27.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_x-0.1.15.dist-info/RECORD

@@ -0,0 +1,10 @@
+arcade_x/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arcade_x/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arcade_x/tools/constants.py,sha256=d-OJK5Qx05JRUcpK5G1DcYB91wT37hFSzGmIYfwlEtA,42
+arcade_x/tools/tweets.py,sha256=S1Psv-gFePz-8ibnp7rY-GCdogkAm-hJQZpHf7hUusk,7498
+arcade_x/tools/users.py,sha256=gopYKTBOwbZAeVdL_T3vwkepbpv1bdPbqcU_2oPC3SY,2132
+arcade_x/tools/utils.py,sha256=Xx4S5bq0udUwSiodf5cs19ftgWHROO-scpY3RY-Fam8,5376
+arcade_x-0.1.15.dist-info/METADATA,sha256=4Y_NCBB8UOHDcKEdJMGGWVV1FfsEMkluR3ebobt0OwE,835
+arcade_x-0.1.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+arcade_x-0.1.15.dist-info/licenses/LICENSE,sha256=f4Q0XUZJ2MqZBO1XsqqHhuZfSs2ar1cZEJ45150zERo,1067
+arcade_x-0.1.15.dist-info/RECORD,,

{arcade_x-0.1.5.dist-info → arcade_x-0.1.15.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{arcade_x-0.1.5.dist-info → arcade_x-0.1.15.dist-info/licenses}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024, arcadeai
+Copyright (c) 2025, Arcade AI
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

arcade_x-0.1.5.dist-info/METADATA

@@ -1,14 +0,0 @@
-Metadata-Version: 2.1
-Name: arcade_x
-Version: 0.1.5
-Summary: LLM tools for interacting with X (Twitter)
-Author: Arcade AI
-Author-email: dev@arcade-ai.com
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: arcade-ai (==0.1.5)
-Requires-Dist: httpx (>=0.27.2,<0.28.0)

arcade_x-0.1.5.dist-info/RECORD

@@ -1,9 +0,0 @@
-arcade_x/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arcade_x/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arcade_x/tools/tweets.py,sha256=IDAjx1j_XLoc7ILyuRKVyjTPwQeNtD47lnyKUMO-WpU,6594
-arcade_x/tools/users.py,sha256=zNACU9UhQJkGNnrei-E6GWvFnbDzg0YG9pkdplu8TzM,2148
-arcade_x/tools/utils.py,sha256=VEeUo715m6l6X9Syszy2E72rdvv4h_tc-P7wMaQEbGo,4044
-arcade_x-0.1.5.dist-info/LICENSE,sha256=SphQPbiNmBD1J6yJ7oxG9bIZDbj8lNHKSv5Kl86zA40,1066
-arcade_x-0.1.5.dist-info/METADATA,sha256=pa4GiYU352AShVYdd2rDjVa3AP5b1sFtJpi1gUihQmM,510
-arcade_x-0.1.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-arcade_x-0.1.5.dist-info/RECORD,,