Merge pull request #3 from midirhee12/main

Author: maningreen

.env.example

@@ -42,6 +42,10 @@ PROD_COG_IGNORE_LIST="rolecount,mail,git" # Default ignores ATL-specific cogs
 # Sentry (Error Tracking)
 # SENTRY_URL=""
 
+# Wolfram Alpha (Math/Science Queries)
+# MAKE SURE THIS IS FOR THE SIMPLE API OR IT WILL NOT WORK
+# WOLFRAM_APP_ID=""
+
 # InfluxDB (Metrics/Logging)
 # ------------------
 

DEVELOPER.md

@@ -26,6 +26,6 @@ Explore the following pages for more detailed information on specific developmen
 * **[Database Controller Patterns](./docs/content/dev/database_patterns.md)**
   * Using controllers for CRUD, transactions, relations.
   * Best practices for database interactions in code.
-* **[Docker Environment](./docs/content/dev/docker_environment.md)** (Optional)
+* **[Docker Environment](./docs/content/dev/docker_development.md)** (Optional)
   * Setting up and using the Docker-based development environment.
   * Running commands within Docker containers.

tux/cog_loader.py

@@ -44,6 +44,7 @@ def __init__(self, bot: commands.Bot) -> None:
             "utility": 30,
             "info": 20,
             "fun": 10,
+            "tools": 5,
         }
 
     async def is_cog_eligible(self, filepath: Path) -> bool:

tux/cogs/fun/fact.py

@@ -1,69 +1,145 @@
 import random
+from enum import Enum
 
+from discord import app_commands
 from discord.ext import commands
 
 from tux.bot import Tux
 from tux.ui.embeds import EmbedCreator
+from tux.utils.config import CONFIG
+from tux.utils.functions import docstring_parameter
+
+linux_facts = [
+    "The Linux kernel has over 36 million lines of code in its Git repository.",
+    "The vast majority of the world's supercomputers run on Linux.",
+    "Linux 1.0 was launched on September 17, 1991 featuring 176,250 lines of code.",
+    "There's an easter egg in `apt` if you enter `apt moo`.",
+    "Linus Torvalds was around 22 years old when he started work on the Linux Kernel in 1991. In the same year, he also released prototypes of the kernel publicly.",
+    "Linux's 1.0 release was in March 1994.",
+    "Less than 1% of the latest kernel release includes code written by Linus Torvalds.",
+    "Approximately 13.3% of the latest Linux kernel is made up of blank lines.",
+    "Vim has various easter eggs. A notable one is found by typing :help 42 into the command bar.",
+    "Slackware is the oldest active linux distribution being released on the 17th July 1993.",
+    "Freax was the original planned name for Linux.",
+    "The first GUI that ran on Linux was X Window System. It ran on Linux Kernel version 0.95.",
+    "The Linux Kernel was the first OS kernel to support x86-64 in 2001.",
+    "Over 14,600 individual developers from over 1,300 different companies have contributed to the kernel.",
+    "95% of the Linux kernel is written in the C programming Language. Assembly language is the second most used language for Linux at 2.8%.",
+    "The first kernel version - Version 0.01 - contained about 10,000 lines of code.",
+    "96.3% of the top 1,000,000 web servers were reported to run on Linux.",
+    "In the early 2000s, Steve Jobs, who at the time was the CEO of Apple, offered a job to Linus Torvalds to work on OSX which Torvalds declined.",
+    "Linus Torvalds said that he would have never created Linux if FreeBSD had been available at the time.",
+    "Linux is used by every major space programme in the world including NASA, SpaceX, and the European Space Agency.",
+]
+
+cat_facts = [
+    "Unlike dogs, cats do not have a sweet tooth. Scientists believe this is due to a mutation in a key taste receptor.",
+    "When a cat chases its prey, it keeps its head level. Dogs and humans bob their heads up and down.",
+    "The technical term for a cat's hairball is a “bezoar.”",
+    "A group of cats is called a “clowder.”",
+    "A cat can't climb head first down a tree because every claw on a cat's paw points the same way. To get down from a tree, a cat must back down.",
+    "Cats make about 100 different sounds. Dogs make only about 10.",
+    "Every year, nearly four million cats are eaten in Asia.",
+    "There are more than 500 million domestic cats in the world, with approximately 40 recognized breeds.",
+    "Approximately 24 cat skins can make a coat.",
+    "While it is commonly thought that the ancient Egyptians were the first to domesticate cats, the oldest known pet cat was recently found in a 9,500-year-old grave on the Mediterranean island of Cyprus. This grave predates early Egyptian art depicting cats by 4,000 years or more.",
+    "During the time of the Spanish Inquisition, Pope Innocent VIII condemned cats as evil and thousands of cats were burned. Unfortunately, the widespread killing of cats led to an explosion of the rat population, which exacerbated the effects of the Black Death.",
+    "During the Middle Ages, cats were associated with witchcraft, and on St. John's Day, people all over Europe would stuff them into sacks and toss the cats into bonfires. On holy days, people celebrated by tossing cats from church towers.",
+    "The first cat in space was a French cat named Felicette (a.k.a. “Astrocat”) In 1963, France blasted the cat into outer space. Electrodes implanted in her brains sent neurological signals back to Earth. She survived the trip.",
+    "The group of words associated with cat (catt, cath, chat, katze) stem from the Latin catus, meaning domestic cat, as opposed to feles, or wild cat.",
+    "The term “puss” is the root of the principal word for “cat” in the Romanian term pisica and the root of secondary words in Lithuanian (puz) and Low German puus. Some scholars suggest that “puss” could be imitative of the hissing sound used to get a cat's attention. As a slang word for the female pudenda, it could be associated with the connotation of a cat being soft, warm, and fuzzy.",
+    "Approximately 40,000 people are bitten by cats in the U.S. annually.",
+    "Cats are the world's most popular pets, outnumbering dogs by as many as three to one",
+    "Cats are North America's most popular pets: there are 73 million cats compared to 63 million dogs. Over 30% of households in North America own a cat.",
+    "According to Hebrew legend, Noah prayed to God for help protecting all the food he stored on the ark from being eaten by rats. In reply, God made the lion sneeze, and out popped a cat.",
+    "A cat's hearing is better than a dog's. And a cat can hear high-frequency sounds up to two octaves higher than a human.",
+    "A cat can travel at a top speed of approximately 31 mph (49 km) over a short distance.",
+    "A cat rubs against people not only to be affectionate but also to mark out its territory with scent glands around its face. The tail area and paws also carry the cat's scent.",
+    "Researchers are unsure exactly how a cat purrs. Most veterinarians believe that a cat purrs by vibrating vocal folds deep in the throat. To do this, a muscle in the larynx opens and closes the air passage about 25 times per second.",
+    "When a family cat died in ancient Egypt, family members would mourn by shaving off their eyebrows. They also held elaborate funerals during which they drank wine and beat their breasts. The cat was embalmed with a sculpted wooden mask and the tiny mummy was placed in the family tomb or in a pet cemetery with tiny mummies of mice.",
+    "In 1888, more than 300,000 mummified cats were found an Egyptian cemetery. They were stripped of their wrappings and carted off to be used by farmers in England and the U.S. for fertilizer.",
+]
+
+tux_facts = [
+    f"As of 2025, {CONFIG.BOT_NAME} has over 20 thousand lines of code.",
+    f"The first stable release of {CONFIG.BOT_NAME} was over 1 year after its creation.",
+    f"{CONFIG.BOT_NAME} is fully open source and available on GitHub (https://github.com/allthingslinux/tux). Unless you forked it and made it private, in which case, please make it public (GPLv3).",
+]
+
+
+class FactType(Enum):
+    LINUX = "Linux"
+    TUX = f"{CONFIG.BOT_NAME}"
+    CAT = "Cat"
+    RANDOM = "Random"
+
+
+# dictionary to map fact types to their respective lists
+# TODO: add more facts and make some grabbed from apis
+"""
+https://uselessfacts.jsph.pl/
+https://alexwohlbruck.github.io/cat-facts/
+https://dukengn.github.io/Dog-facts-API/
+https://kinduff.github.io/dog-api/
+https://github.com/wh-iterabb-it/meowfacts
+https://chandan-02.github.io/anime-facts-rest-api/
+"""
+fact_type_map = {
+    FactType.LINUX: linux_facts,
+    FactType.TUX: tux_facts,
+    FactType.CAT: cat_facts,
+    FactType.RANDOM: linux_facts + tux_facts + cat_facts,
+}
 
 
 class Fact(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
-        self.facts = [
-            "The Linux kernel has over 36 million lines of code in its Git repository.",
-            "The vast majority of the world's supercomputers run on Linux.",
-            "Linux 1.0 was launched on September 17, 1991 featuring 176,250 lines of code.",
-            "There's an easter egg in `apt` if you enter `apt moo`.",
-            "Linus Torvalds was around 22 years old when he started work on the Linux Kernel in 1991. In the same year, he also released prototypes of the kernel publicly.",
-            "Linux's 1.0 release was in March 1994.",
-            "Less than 1% of the latest kernel release includes code written by Linus Torvalds.",
-            "Approximately 13.3% of the latest Linux kernel is made up of blank lines.",
-            "Vim has various easter eggs. A notable one is found by typing :help 42 into the command bar.",
-            "Slackware is the oldest active linux distribution being released on the 17th July 1993.",
-            "Freax was the original planned name for Linux.",
-            "The first GUI that ran on Linux was X Window System. It ran on Linux Kernel version 0.95.",
-            "The Linux Kernel was the first OS kernel to support x86-64 in 2001.",
-            "Over 14,600 individual developers from over 1,300 different companies have contributed to the kernel.",
-            "95% of the Linux kernel is written in the C programming Language. Assembly language is the second most used language for Linux at 2.8%.",
-            "The first kernel version - Version 0.01 - contained about 10,000 lines of code.",
-            "96.3% of the top 1,000,000 web servers were reported to run on Linux.",
-            "In the early 2000s, Steve Jobs, who at the time was the CEO of Apple, offered a job to Linus Torvalds to work on OSX which Torvalds declined.",
-            "Linus Torvalds said that he would have never created Linux if FreeBSD had been available at the time.",
-            "Linux is used by every major space programme in the world including NASA, SpaceX, and the European Space Agency.",
-        ]
-
-    @commands.hybrid_command(
-        name="fact",
-        aliases=["funfact"],
+
+    @commands.hybrid_command(name="fact", aliases=["funfact"])
+    @app_commands.describe(fact_type="Select the category of fact to retrieve")
+    @app_commands.choices(fact_type=[app_commands.Choice(name=ft.value, value=ft.value) for ft in FactType])
+    @docstring_parameter(
+        f"Available categories: {', '.join([ft.value for ft in FactType])}. Default category is {FactType.RANDOM.value}.",
     )
-    async def fact(self, ctx: commands.Context[Tux]) -> None:
+    async def fact(self, ctx: commands.Context[Tux], fact_type: str = FactType.RANDOM.value) -> None:
         """
-        Get a random fun fact.
+        Get a random fun fact from the specified category.
+
+        {0}
 
         Parameters
         ----------
         ctx : commands.Context[Tux]
-            The context object for the command.
+            The context in which the command is being invoked.
+        fact_type : str
+            The category of fact to retrieve. {0}
         """
+
+        # Map selected name back to enum
+        mapping = {ft.value: ft for ft in FactType}
+        if fact_type not in mapping:
+            opts = ", ".join(mapping.keys())
+            await ctx.send(f"Invalid category '{fact_type}'. Available: {opts}.")
+            return
+        sel = mapping[fact_type]
+        # Pick a random fact
+        facts = fact_type_map.get(sel, [])
+        description = random.choice(facts) if facts else "No facts available for this category."
+
         embed = EmbedCreator.create_embed(
             bot=self.bot,
             embed_type=EmbedCreator.INFO,
             user_name=ctx.author.name,
             user_display_avatar=ctx.author.display_avatar.url,
-            title="Fun Fact",
-            description=random.choice(self.facts),
-            custom_author_text="Click here to submit more facts here!",
+            title=f"Fun Fact ({sel.value})",
+            description=description,
+            custom_author_text="Click here to submit more facts!",
             custom_author_text_url="https://github.com/allthingslinux/tux/blob/main/tux/cogs/fun/fact.py",
             custom_author_icon_url="https://github.com/allthingslinux/tux/blob/main/assets/emojis/tux_info.png?raw=true",
         )
 
-        # # set author
-        # embed.set_author(
-        #     name="Submit more facts here!",
-        #     url="https://github.com/allthingslinux/tux/blob/main/tux/cogs/fun/fact.py",
-        #     icon_url="https://github.com/allthingslinux/tux/blob/main/assets/emojis/tux_info.png?raw=true",
-        # )
-
+        # Send the fact embed
         await ctx.send(embed=embed)
 
 

tux/cogs/services/influxdblogger.py

@@ -66,7 +66,7 @@ async def logger(self) -> None:
                 guild_id = int(guild.guild_id)
 
                 # Collect data by querying controllers
-                starboard_stats = await self.db.starboard_message.find_many(where={"guild_id": guild_id})
+                starboard_stats = await self.db.starboard_message.find_many(where={"message_guild_id": guild_id})
 
                 snippet_stats = await self.db.snippet.find_many(where={"guild_id": guild_id})
 

tux/cogs/tools/__init__.py

@@ -0,0 +1,99 @@
+import asyncio
+import io
+from urllib.parse import quote_plus
+
+import aiohttp
+import discord
+from discord import app_commands
+from discord.ext import commands
+from loguru import logger
+from PIL import Image
+
+from tux.bot import Tux
+from tux.ui.embeds import EmbedCreator
+from tux.utils.config import CONFIG
+
+
+class Wolfram(commands.Cog):
+    def __init__(self, bot: Tux) -> None:
+        self.bot = bot
+
+        # Verify AppID configuration; unload cog if missing
+        if not CONFIG.WOLFRAM_APP_ID:
+            logger.warning("Wolfram Alpha API ID is not set. Some Science/Math commands will not work.")
+            # Store the task reference
+            self._unload_task = asyncio.create_task(self._unload_self())
+        else:
+            logger.info("Wolfram Alpha API ID is set, Science/Math commands that depend on it will work.")
+
+    async def _unload_self(self):
+        """Unload this cog if configuration is missing."""
+        try:
+            await self.bot.unload_extension("tux.cogs.tools.wolfram")
+            logger.info("Wolfram cog has been unloaded due to missing configuration")
+        except Exception as e:
+            logger.error(f"Failed to unload Wolfram cog: {e}")
+
+    @commands.hybrid_command(name="wolfram", description="Query Wolfram|Alpha Simple API and return an image result.")
+    @app_commands.describe(
+        query="The input query for Wolfram|Alpha, e.g. 'integrate x^2' or 'What is the capital of France?'",
+    )
+    async def wolfram(self, ctx: commands.Context[Tux], *, query: str) -> None:
+        """
+        Send a query to Wolfram|Alpha Simple API and return the visual result.
+
+        Parameters
+        ----------
+        ctx : commands.Context[Tux]
+            Invocation context for the command.
+        query : str
+            Input string for the Wolfram|Alpha query, e.g. 'integrate x^2'.
+        """
+
+        await ctx.defer()
+
+        # Build the Simple API endpoint URL with URL-encoded query
+        encoded = quote_plus(query)
+        url = f"https://api.wolframalpha.com/v1/simple?appid={CONFIG.WOLFRAM_APP_ID}&i={encoded}"
+
+        try:
+            # Perform async HTTP GET with a 10-second timeout
+            timeout = aiohttp.ClientTimeout(total=10)
+            async with aiohttp.ClientSession() as session, session.get(url, timeout=timeout) as resp:
+                resp.raise_for_status()
+                img_data = await resp.read()
+        except Exception:
+            # On error, notify user via an error embed
+            embed = EmbedCreator.create_embed(
+                bot=self.bot,
+                embed_type=EmbedCreator.ERROR,
+                user_name=ctx.author.name,
+                user_display_avatar=ctx.author.display_avatar.url,
+                description="Failed to retrieve image from Wolfram|Alpha Simple API.",
+            )
+            await ctx.send(embed=embed)
+            return
+
+        # Crop the top 80 pixels from the fetched image
+        image = Image.open(io.BytesIO(img_data))
+        width, height = image.size
+        cropped = image.crop((0, 80, width, height))
+        buffer = io.BytesIO()
+        cropped.save(buffer, format=image.format or "PNG")
+        buffer.seek(0)
+        image_file = discord.File(buffer, filename="wolfram.png")
+
+        embed = EmbedCreator.create_embed(
+            bot=self.bot,
+            embed_type=EmbedCreator.INFO,
+            user_name=ctx.author.name,
+            user_display_avatar=ctx.author.display_avatar.url,
+            title=f"Wolfram|Alpha: {query}",
+        )
+        # Display the image via embed attachment URL
+        embed.set_image(url="attachment://wolfram.png")
+        await ctx.send(embed=embed, file=image_file)
+
+
+async def setup(bot: Tux) -> None:
+    await bot.add_cog(Wolfram(bot))

tux/cogs/tools/wolfram.py

@@ -81,6 +81,7 @@ async def on_reaction_add(self, reaction: discord.Reaction, user: discord.User)
                 and embed.author.name.startswith("Poll")
                 and reaction.emoji not in [f"{num + 1}\u20e3" for num in range(9)]
             ):
+                await reaction.remove(user)
                 await reaction.clear()
 
     @app_commands.command(name="poll", description="Creates a poll.")

tux/cogs/utility/poll.py

@@ -413,6 +413,7 @@ async def _create_category_options(self) -> list[discord.SelectOption]:
             "levels": "📈",
             "services": "🔌",
             "guild": "🏰",
+            "tools": "🛠",
         }
 
         options: list[discord.SelectOption] = []

tux/help.py

@@ -84,6 +84,9 @@ def BOT_TOKEN(self) -> str:  # noqa: N802
         # before this property is accessed.
         return get_bot_token()  # Get token based on manager's current env
 
+    # Wolfram
+    WOLFRAM_APP_ID: Final[str] = os.getenv("WOLFRAM_APP_ID", "")
+
     # InfluxDB
     INFLUXDB_TOKEN: Final[str] = os.getenv("INFLUXDB_TOKEN", "")
     INFLUXDB_URL: Final[str] = os.getenv("INFLUXDB_URL", "")