feat(util.socials): add reddit command

Author: orangci

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+This project follows the [Semantic Versioning 2.0.0](https://semver.org/) specification as of 14.04.2025. This changelog was initiated at the same date.
+
+## 1.0.0
+The initiating version. I used 1.0.0 instead of 0.1.0 as this project has already been in production for almost a year, and is stable.
+
+#### 1.0.1
+Patched users being able to enter location names above 300 characters in util.time.
+
+### 1.1.0
+Added the util.weather cog.
+
+### 1.2.0
+Added the util.social cog with the github command.
+
+#### 1.2.1
+Fixed the bot's name being hardcoded in some places as "Takina" instead of using the BOT_NAME environment variable.
+
+### 1.3.0
+Added the reddit command to the util.socials cog.

README.md

@@ -1,4 +1,4 @@
-# Takina v1.2.1
+# Takina
 A simple multipurpose bot for Discord. Also the very cutest Discord bot. Sakanaaa <3
 
 For a list of features and other information please visit: https://takina.orangc.net.
@@ -44,6 +44,6 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md).
 - [Privacy Policy](https://orangc.net/takina/privacy.html)
 
 ## Specifications
-- This project follows the [Semantic Versioning 2.0.0](https://semver.org/) specification as of 14.04.2025.
+- This project follows the [Semantic Versioning 2.0.0](https://semver.org/) specification as of 14.04.2025. You may see the current version and changelog [here](./CHANGELOG.md).
 - This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification as of 01.10.2024.
 <!-- note to self: count takina loc with: `git ls-files | grep '\.py$' | xargs wc -l | tail -n 1`, 9,839 as of 14.04.2025 -->

docker-compose.yml

@@ -21,6 +21,9 @@ services:
       - BOT_NAME=Takina
       - DB_NAME=takina
       - EMBED_COLOR=0x2B2D31
+      - GITHUB_AUTH_TOKEN= # if you want the github command in util.socials to work, set this variable
+      - REDDIT_CLIENT_ID= # You must set the REDDIT_CLIENT_ID and REDDIT_CLIENT_SECRET environment variables if you would like the reddit command in util.socials to work. To get your own Reddit client secret and ID visit https://www.reddit.com/prefs/apps.
+      - REDDIT_CLIENT_SECRET= # see above
 
 volumes:
   data-volume:

requirements.txt

@@ -15,6 +15,7 @@ ping3==4.0.8 # util.utils
 google-books-api-wrapper==1.0.5 # util.books
 aladhan.py==1.2.2  ## islam.salah
 PyGithub==2.6.1 # util.socials
+asyncpraw==7.8.1 # util.socials
 pytz==2025.2 # util.time
 tzfpy==1.0.0 # util.time
 geopy==2.4.1 # util.time

takina/cogs/util/socials.py

@@ -1,4 +1,4 @@
-import nextcord
+import nextcord, asyncpraw
 from nextcord.ext import commands
 from config import *
 from ..libs.oclib import *
@@ -34,6 +34,7 @@ async def slash_github(
         await interaction.send(embed=embed)
 
     async def fetch_user_information(self, username):
+        username = username[1:] if username.startswith("@") else username
         embed = nextcord.Embed(color=EMBED_COLOR, description="", title=username)
         github = Github(GITHUB_AUTH_TOKEN)
         try:
@@ -75,5 +76,109 @@ async def fetch_user_information(self, username):
         # fmt: on
 
 
+class SocialsReddit(commands.Cog):
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.command(
+        help="Social information command for Reddit. Usage: `reddit orangci`.",
+    )
+    async def reddit(self, ctx: commands.Context, *, username: str):
+        embed = await self.fetch_user_information(username)
+        await ctx.reply(embed=embed, mention_author=False)
+        pass
+
+    @nextcord.slash_command(
+        name="reddit", description="Social information command for Reddit."
+    )
+    async def slash_reddit(
+        self,
+        interaction: nextcord.Interaction,
+        *,
+        username: str = nextcord.SlashOption(
+            description="The Reddit username to fetch information on.",
+            required=True,
+        ),
+    ):
+        await interaction.response.defer()
+        embed = await self.fetch_user_information(username)
+        await interaction.send(embed=embed)
+
+    async def fetch_user_information(self, username):
+        username = username[3:] if username.startswith("/u/") else username
+        username = username[2:] if username.startswith("u/") else username
+
+        reddit = asyncpraw.Reddit(
+            client_id=REDDIT_CLIENT_ID,
+            client_secret=REDDIT_CLIENT_SECRET,
+            user_agent=BOT_NAME,
+        )
+
+        embed = nextcord.Embed(color=0xFF4500, description="")
+
+        try:
+            user = await reddit.redditor(username)
+            await user.load()
+        except:
+            embed.color = ERROR_COLOR
+            embed.description = ":x: That Reddit account does not exist."
+            return embed
+
+        # fmt: off
+        embed.set_thumbnail(url=user.icon_img)
+        embed.title = user.name
+        embed.description += f"{user.subreddit.public_description}\n" if user.subreddit.public_description else ""
+        embed.description += f"\n**Joined Reddit**: <t:{int(user.created_utc)}:D>"
+        embed.description += f"\n**Post Karma**: {user.link_karma}"
+        embed.description += f"\n**Comment Karma**: {user.comment_karma}"
+        embed.description += f"\n**Total Posts**: {user.link_karma}"
+        embed.description += f"\n**Total Comments**: {user.comment_karma}"
+        moderated_subreddits = await user.moderated()
+        moderated_subreddit_names = [f"r/{sub.display_name}" for sub in moderated_subreddits]
+        embed.description += f"\n**Moderator in**: {', '.join(moderated_subreddit_names)}" if moderated_subreddit_names else ""
+        return embed
+        # fmt: on
+
+
+class SocialsPLACEHOLDER(commands.Cog):
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.command(
+        help="Social information command for PLACEHOLDER. Usage: `PLACEHOLDER orangci`.",
+    )
+    async def PLACEHOLDER(self, ctx: commands.Context, *, username: str):
+        embed = ""
+        await ctx.reply(embed=embed, mention_author=False)
+        pass
+
+    @nextcord.slash_command(
+        name="PLACEHOLDER", description="Social information command for PLACEHOLDER."
+    )
+    async def slash_PLACEHOLDER(
+        self,
+        interaction: nextcord.Interaction,
+        *,
+        username: str = nextcord.SlashOption(
+            description="The PLACEHOLDER username to fetch information on.",
+            required=True,
+        ),
+    ):
+        await interaction.response.defer()
+        embed = ""
+        await interaction.send(embed=embed)
+
+
 def setup(bot: commands.Bot):
-    bot.add_cog(SocialsGitHub(bot))
+    if GITHUB_AUTH_TOKEN:
+        bot.add_cog(SocialsGitHub(bot))
+    else:
+        print(
+            "You must set the GITHUB_AUTH_TOKEN environment variable if you want the github command to work. Skipping loading the github command. To get your own github auth token, visit <https://github.com/settings/tokens/new>."
+        )
+    if REDDIT_CLIENT_ID and REDDIT_CLIENT_SECRET:
+        bot.add_cog(SocialsReddit(bot))
+    else:
+        print(
+            "You must set the REDDIT_CLIENT_ID and REDDIT_CLIENT_SECRET environment variables if you would like the reddit command to work. Skipping loading the reddit command. \nTo get your own Reddit application visit <https://www.reddit.com/prefs/apps>."
+        )

takina/config.py

@@ -7,6 +7,8 @@
 DB_NAME = getenv("DB_NAME").lower()
 MONGO_URI = getenv("MONGO")
 GITHUB_AUTH_TOKEN = getenv("GITHUB_AUTH_TOKEN")
+REDDIT_CLIENT_ID = getenv("REDDIT_CLIENT_ID")
+REDDIT_CLIENT_SECRET = getenv("REDDIT_CLIENT_SECRET")
 ERROR_COLOR = 0xFF0037
 
 EMBED_COLOR_STR = getenv("EMBED_COLOR", "#2B2D31")