arcade-x 0.1.15__tar.gz

arcade_x-0.1.15/.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_x-0.1.15/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+files: ^.*/x/.*
+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_x-0.1.15/.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_x-0.1.15/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+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_x-0.1.15/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_x-0.1.15/PKG-INFO

@@ -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/arcade_x/tools/constants.py

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

arcade_x-0.1.15/arcade_x/tools/tweets.py

@@ -0,0 +1,215 @@
+from typing import Annotated, Any
+
+import httpx
+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,
+)
+
+# Manage Tweets Tools. See developer docs for additional available parameters:
+# https://developer.x.com/en/docs/x-api/tweets/manage-tweets/api-reference
+
+
+@tool(
+    requires_auth=X(
+        scopes=["tweet.read", "tweet.write", "users.read"],
+    )
+)
+async def post_tweet(
+    context: ToolContext,
+    tweet_text: Annotated[str, "The text content of the tweet you want to post"],
+) -> Annotated[str, "Success string and the URL of the tweet"]:
+    """Post a tweet to X (Twitter)."""
+
+    headers = get_headers_with_token(context)
+    payload = {"text": tweet_text}
+
+    async with httpx.AsyncClient() as client:
+        response = await client.post(TWEETS_URL, headers=headers, json=payload, timeout=10)
+        response.raise_for_status()
+
+    tweet_id = response.json()["data"]["id"]
+    return f"Tweet with id {tweet_id} posted successfully. URL: {get_tweet_url(tweet_id)}"
+
+
+@tool(requires_auth=X(scopes=["tweet.read", "tweet.write", "users.read"]))
+async def delete_tweet_by_id(
+    context: ToolContext,
+    tweet_id: Annotated[str, "The ID of the tweet you want to delete"],
+) -> Annotated[str, "Success string confirming the tweet deletion"]:
+    """Delete a tweet on X (Twitter)."""
+
+    headers = get_headers_with_token(context)
+    url = f"{TWEETS_URL}/{tweet_id}"
+
+    async with httpx.AsyncClient() as client:
+        response = await client.delete(url, headers=headers, timeout=10)
+        response.raise_for_status()
+
+    return f"Tweet with id {tweet_id} deleted successfully."
+
+
+@tool(requires_auth=X(scopes=["tweet.read", "users.read"]))
+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. 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, Any] = {
+        "query": f"from:{username}",
+        "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",
+    }
+    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)
+        response.raise_for_status()
+
+    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
+    )
+
+    # Parse the response data
+    response_data = parse_search_recent_tweets_response(response_data)
+
+    return response_data
+
+
+@tool(requires_auth=X(scopes=["tweet.read", "users.read"]))
+async def search_recent_tweets_by_keywords(
+    context: ToolContext,
+    keywords: Annotated[
+        list[str] | None, "List of keywords that must be present in the tweet"
+    ] = None,
+    phrases: Annotated[
+        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. 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.
+    Includes replies and reposts.
+    One of the following input parameters MUST be provided: keywords, phrases
+    """
+
+    if not any([keywords, phrases]):
+        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",
+            retry_after_ms=500,  # Play nice with X API rate limits
+        )
+
+    headers = get_headers_with_token(context)
+
+    query = "".join([f'"{phrase}" ' for phrase in (phrases or [])])
+    if keywords:
+        query += " ".join(keywords or [])
+
+    params: dict[str, Any] = {
+        "query": query.strip(),
+        "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",
+    }
+    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)
+        response.raise_for_status()
+
+    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
+    )
+
+    # Parse the response data
+    response_data = parse_search_recent_tweets_response(response_data)
+
+    return response_data
+
+
+@tool(requires_auth=X(scopes=["tweet.read", "users.read"]))
+async def lookup_tweet_by_id(
+    context: ToolContext,
+    tweet_id: Annotated[str, "The ID of the tweet you want to look up"],
+) -> Annotated[dict[str, Any], "Dictionary containing the tweet data"]:
+    """Look up a tweet on X (Twitter) by tweet ID."""
+
+    headers = get_headers_with_token(context)
+    params = {
+        "expansions": "author_id",
+        "user.fields": "id,name,username,entities",
+        "tweet.fields": "entities,note_tweet",
+    }
+    params = expand_attached_media(params)
+
+    url = f"{TWEETS_URL}/{tweet_id}"
+
+    async with httpx.AsyncClient() as client:
+        response = await client.get(url, headers=headers, params=params, timeout=10)
+        response.raise_for_status()
+
+    response_data: dict[str, Any] = response.json()
+
+    # 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]
+    else:
+        response_data["data"] = {}
+
+    return response_data

arcade_x-0.1.15/arcade_x/tools/users.py

@@ -0,0 +1,64 @@
+from typing import Annotated
+
+import httpx
+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,
+    expand_urls_in_user_url,
+    get_headers_with_token,
+)
+
+# Users Lookup Tools. See developer docs for additional available query parameters:
+# https://developer.x.com/en/docs/x-api/users/lookup/api-reference
+
+
+@tool(requires_auth=X(scopes=["users.read", "tweet.read"]))
+async def lookup_single_user_by_username(
+    context: ToolContext,
+    username: Annotated[str, "The username of the X (Twitter) user to look up"],
+) -> Annotated[dict, "User information including id, name, username, and description"]:
+    """Look up a user on X (Twitter) by their username."""
+
+    headers = get_headers_with_token(context)
+
+    user_fields = ",".join([
+        "created_at",
+        "description",
+        "id",
+        "location",
+        "most_recent_tweet_id",
+        "name",
+        "pinned_tweet_id",
+        "profile_image_url",
+        "protected",
+        "public_metrics",
+        "url",
+        "username",
+        "verified",
+        "verified_type",
+        "withheld",
+        "entities",
+    ])
+    url = f"https://api.x.com/2/users/by/username/{username}?user.fields={user_fields}"
+
+    async with httpx.AsyncClient() as client:
+        response = await client.get(url, headers=headers, timeout=10)
+        if response.status_code == 404:
+            # User not found
+            raise RetryableToolError(
+                "User not found",
+                developer_message=f"User with username '{username}' not found.",
+                additional_prompt_content="Please check the username and try again.",
+                retry_after_ms=500,  # Play nice with X API rate limits
+            )
+        response.raise_for_status()
+    # Parse the response JSON
+    user_data = response.json()["data"]
+
+    user_data = expand_urls_in_user_description(user_data, delete_entities=False)
+    user_data = expand_urls_in_user_url(user_data, delete_entities=True)
+
+    return {"data": user_data}