7c6a739f25
| Name | Description | Package | Version | |----------------------------|------------------------------------------------------------------|---------|---------| | Reddit.SubmitTextPost | Submit a text-based post to a subreddit | Reddit | 0.0.1 | | Reddit.CommentOnPost | Comment on a Reddit post | Reddit | 0.0.1 | | Reddit.ReplyToComment | Reply to a Reddit comment | Reddit | 0.0.1 | | Reddit.GetPostsInSubreddit | Gets posts titles, links, and other metadata in the specified subreddit | Reddit | 0.0.1 | | Reddit.GetContentOfPost | Get the content (body) of a Reddit post by its identifier. | Reddit | 0.0.1 | | Reddit.GetContentOfMultiplePosts | Get the content (body) of multiple Reddit posts by their identifiers. | Reddit | 0.0.1 | | Reddit.GetTopLevelComments | Get the first page of top-level comments of a Reddit post. | Reddit | 0.0.1 | ### Why not use an SDK? Reddit API does not have an official SDK, although [PRAW](https://github.com/praw-dev/praw) has large community support. I played around with PRAW, but ultimately decided to not use an SDK. PRAW made it incredibly easy to work with Reddit Objects, but there were a few drawbacks that ultimately swayed me to not use it: 1. PRAW assumes that it will do the auth for you. A client ID and secret must be passed to PRAW, but a tool only has the auth token. I was able to hack around this by manipulating private properties - but it felt too hacky 2. PRAW does not support Python 3.13 3. PRAW is not async. There is [AsyncPRAW](https://github.com/praw-dev/asyncpraw), but the community does not look active there.
113 lines
3.5 KiB
Python
113 lines
3.5 KiB
Python
from typing import Annotated, Optional
|
|
|
|
from arcade.sdk import ToolContext, tool
|
|
from arcade.sdk.auth import Reddit
|
|
|
|
from arcade_reddit.client import RedditClient
|
|
from arcade_reddit.utils import (
|
|
create_fullname_for_comment,
|
|
create_fullname_for_post,
|
|
normalize_subreddit_name,
|
|
parse_api_comment_response,
|
|
remove_none_values,
|
|
)
|
|
|
|
|
|
@tool(requires_auth=Reddit(scopes=["submit"]))
|
|
async def submit_text_post(
|
|
context: ToolContext,
|
|
subreddit: Annotated[str, "The name of the subreddit to which the post will be submitted"],
|
|
title: Annotated[str, "The title of the submission"],
|
|
body: Annotated[
|
|
Optional[str],
|
|
"The body of the post in markdown format. Should never be the same as the title",
|
|
] = None,
|
|
nsfw: Annotated[
|
|
Optional[bool],
|
|
"Indicates if the submission has content that is 'Not Safe For Work' (NSFW). "
|
|
"Default is False",
|
|
] = False,
|
|
spoiler: Annotated[
|
|
Optional[bool],
|
|
"Indicates if the post is marked as a spoiler. Default is False",
|
|
] = False,
|
|
send_replies: Annotated[
|
|
Optional[bool], "If true, sends replies to the user's inbox. Default is True"
|
|
] = True,
|
|
) -> Annotated[dict, "Response from Reddit after submission"]:
|
|
"""Submit a text-based post to a subreddit"""
|
|
|
|
client = RedditClient(context.get_auth_token_or_empty())
|
|
|
|
subreddit = normalize_subreddit_name(subreddit)
|
|
|
|
params = {
|
|
"api_type": "json",
|
|
"sr": subreddit,
|
|
"title": title,
|
|
"kind": "self",
|
|
"nsfw": nsfw,
|
|
"spoiler": spoiler,
|
|
"sendreplies": send_replies,
|
|
"text": body,
|
|
}
|
|
params = remove_none_values(params)
|
|
|
|
data = await client.post("api/submit", data=params)
|
|
return {"data": data["json"].get("data", {}), "errors": data["json"].get("errors", [])}
|
|
|
|
|
|
@tool(requires_auth=Reddit(scopes=["submit"]))
|
|
async def comment_on_post(
|
|
context: ToolContext,
|
|
post_identifier: Annotated[
|
|
str,
|
|
"The identifier of the Reddit post. "
|
|
"The identifier may be a reddit URL, a permalink, a fullname, or a post id.",
|
|
],
|
|
text: Annotated[str, "The body of the comment in markdown format"],
|
|
) -> Annotated[dict, "Response from Reddit after submission"]:
|
|
"""Comment on a Reddit post"""
|
|
|
|
client = RedditClient(context.get_auth_token_or_empty())
|
|
|
|
fullname = create_fullname_for_post(post_identifier)
|
|
|
|
params = {
|
|
"api_type": "json",
|
|
"thing_id": fullname,
|
|
"text": text,
|
|
"return_rtjson": True,
|
|
}
|
|
|
|
data = await client.post("api/comment", data=params)
|
|
|
|
return parse_api_comment_response(data)
|
|
|
|
|
|
@tool(requires_auth=Reddit(scopes=["submit"]))
|
|
async def reply_to_comment(
|
|
context: ToolContext,
|
|
comment_identifier: Annotated[
|
|
str,
|
|
"The identifier of the Reddit comment to reply to. "
|
|
"The identifier may be a comment ID, a reddit URL to the comment, "
|
|
"a permalink to the comment, or the fullname of the comment.",
|
|
],
|
|
text: Annotated[str, "The body of the reply in markdown format"],
|
|
) -> Annotated[dict, "Response from Reddit after submission"]:
|
|
"""Reply to a Reddit comment"""
|
|
|
|
client = RedditClient(context.get_auth_token_or_empty())
|
|
|
|
fullname = create_fullname_for_comment(comment_identifier)
|
|
|
|
params = {
|
|
"api_type": "json",
|
|
"thing_id": fullname,
|
|
"text": text,
|
|
"return_rtjson": True,
|
|
}
|
|
|
|
data = await client.post("api/comment", data=params)
|
|
return parse_api_comment_response(data)
|