fix deployment script

Reviewed-on: #7

looks good

.gitea/workflows/deploy.yaml

@@ -8,21 +8,20 @@ jobs:
   Deploy:
     container:
       volumes:
-        - /home/crate/garfbot:/workspace/crate/garfbot/deploy
+        - /home/crate/garfbot:/workspace/crate/garfbot/garfbot
     steps:
-    - name: Pull Garfbot and restart container
+      - name: Pull GarfBot and re-deploy
-      run: |
+        run: |
-        cd /workspace/crate/garfbot/deploy
+          cd /workspace/crate/garfbot/garfbot
-
+          
-        git pull origin main
+          git pull origin main
+          
+          CHANGED=$(git diff --name-only HEAD~1 HEAD)
         
-        CHANGED=$(git diff --name-only HEAD~1 HEAD)
+          if echo "$CHANGED" | grep -qE "(Dockerfile|requirements\.txt|docker-compose\.yml|\.gitea/workflows/deploy\.yaml)"; then
-        
+            docker compose down
-        if echo "$CHANGED" | grep -qE "(Dockerfile|requirements\.txt|docker-compose\.yml)"; then
+            docker build -t git.crate.zip/crate/garfbot:latest .
-          docker stop garfbot
+            docker compose up -d
-          docker rm garfbot
+          else
-          docker build -t git.crate.zip/crate/garfbot:latest .
+            docker restart garfbot
-          docker run -d --restart always -v $PWD:/usr/src/app --name garfbot git.crate.zip/crate/garfbot:latest
+          fi
-        else
-          docker restart garfbot
-        fi

Dockerfile

@@ -1,19 +1,29 @@
-FROM python:3.11.10-bookworm
+FROM python:alpine
-
 WORKDIR /usr/src/app
 
-RUN apt update
+RUN apk update && \
-RUN apt install -y iputils-ping
+    apk add --no-cache \
-RUN apt install -y dnsutils
+    iputils \
-RUN apt install -y nmap
+    bind-tools \
-RUN apt install -y python3
+    nmap \
-RUN apt install -y python3-pip
+    gcc \
-RUN pip3 install discord
+    musl-dev \
-RUN pip3 install openai
+    jpeg-dev \
-RUN pip3 install aiohttp
+    zlib-dev \
-RUN pip3 install requests
+    freetype-dev \
-RUN pip3 install wikipedia
+    lcms2-dev \
-RUN pip3 install pillow
+    openjpeg-dev \
-RUN pip3 install qrcode
+    tiff-dev \
+    tk-dev \
+    tcl-dev
 
-CMD [ "python", "garfmain.py" ]
+RUN pip3 install --no-cache-dir \
+    discord \
+    openai \
+    aiohttp \
+    requests \
+    wikipedia \
+    pillow \
+    qrcode
+
+CMD [ "python", "garfmain.py" ]

README.md

@@ -2,25 +2,44 @@ Who is GarfBot?
 ======
 ![garfield](https://www.crate.zip/garfield.png)
 
-GarfBot is a discord bot that uses OpenAI's generative pre-trained models to produce text and images for your personal entertainment and companionship. There are a few ways you can interact with him on discord, either in a public server or by direct message:
+GarfBot is a discord bot that uses OpenAI's generative pre-trained models to produce text and images for your personal entertainment and companionship.
+<br>There are a few ways you can interact with him on discord, either in a public server or by direct message:
 
 `hey garfield {prompt}`
-Responds with text.
+<br>Responds with text.
 
 `garfpic {prompt}`
-Responds with an image.
+<br>Responds with an image.
 
 `garfping {target}`
-Responds with iputils-ping result from target.
+<br>Responds with iputils-ping result from target.
 
-`garfpic {target}`
+`garfdns {target}`
-Responds with dns lookup result from target.
+<br>Responds with dns lookup result from target.
 
 `garfhack {target}`
-Responds with nmap scan result from target.
+<br>Responds with nmap scan result from target.
 
 `garfshop {item} {zip}`
-Responds with 10 grocery {item}s from the nearest Kroger location, listed from least to most expensive.
+<br>Responds with 10 grocery {item}s from the nearest Kroger location, listed from least to most expensive.
+
+`garfwiki {query}`
+<br>Garfbot looks up a wikipedia article and will summarize it for you.
+
+`garfqr {text}`
+<br>Create a QR code for any string up to 1000 characters.
+
+`garfbot response {add} {trigger} {response}`
+<br>Add a GarfBot auto response for your server. Use "quotes" if you like.
+
+`garfbot response {remove} {trigger}`
+<br>Remove a GarfBot auto response for your server.
+
+`garfbot response {list}`
+<br>List current GarfBot auto responses for your server.
+
+`garfbot help`
+<br>Show a list of these commands.
 
 Installation
 ======
@@ -38,7 +57,8 @@ GARFBOT_TOKEN = "Discord API token"
 OPENAI_TOKEN = "OpenAI API token"
 ```
 
-I recommend building a docker image using the included DockerFile as a template. Run the container binding /usr/src/app to GarfBot's CWD:
+I recommend building a docker image using the included DockerFile as a template.
+<br>Run the container binding /usr/src/app to GarfBot's CWD:
 
 ```console
 $ docker build -t garfbot .
@@ -53,7 +73,7 @@ If you prefer to install dependencies on you own host and run as a systemd servi
 $ sudo nano /etc/systemd/system/garfbot.service
 ```
 
-Replace {user} with your username:
+Replace $USER with your username:
 
 ```console
 [Unit]
@@ -63,8 +83,8 @@ After=multi-user.target
 [Service]
 Type=simple
 Restart=always
-User={user}
+User=$USER
-WorkingDirectory=/home/{user}/garfbot
+WorkingDirectory=/home/$USER/garfbot
 ExecStart=/usr/bin/python garfbot.py
 
 [Install]

docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  garfbot:
+    image: git.crate.zip/crate/garfbot:latest
+    container_name: garfbot
+    restart: always
+    volumes:
+      - /home/crate/garfbot:/usr/src/app

garfmain.py

@@ -1,12 +1,18 @@
 import config
 import asyncio
 import discord
-import subprocess
 
-from garfpy import(
+from garfpy import (
-    logger, is_private,
+    help,
-    aod_message, generate_qr,
+    logger,
-    Kroger, GarfAI, GarfbotRespond)
+    IPUtils,
+    aod_message,
+    generate_qr,
+    Kroger,
+    GarfAI,
+    GarfbotRespond,
+    WeatherAPI,
+)
 
 
 gapikey = config.GIF_TOKEN
@@ -22,7 +28,9 @@ garfbot = discord.Client(intents=intents)
 
 garf_respond = GarfbotRespond()
 garfield = GarfAI()
+iputils = IPUtils()
 kroger = Kroger()
+weather = WeatherAPI()
 
 
 @garfbot.event
@@ -30,44 +38,36 @@ async def on_ready():
     try:
         garf_respond.load_responses()
         asyncio.create_task(garfield.process_image_requests())
-        logger.info(f"Logged in as {garfbot.user.name} running {txtmodel} and {imgmodel}.")
+        logger.info(
+            f"Logged in as {garfbot.user.name} running {txtmodel} and {imgmodel}."
+        )
     except Exception as e:
         logger.error(e)
 
 
 @garfbot.event
 async def on_message(message):
-
-    content = message.content.strip()
-    lower = content.lower()
-    user = message.author.name
-    guild = message.guild.name if message.guild else "Direct Message"
-    guild_id = message.guild.id
-
-    # Chats & pics
     if message.author == garfbot.user:
         return
 
-    if lower.startswith("hey garfield") or isinstance(message.channel, discord.DMChannel):
+    content = message.content.strip()
-        prompt = content[12:] if lower.startswith("hey garfield") else message.content
+    lower = content.lower()
-        answer = await garfield.generate_chat(prompt)
+    user_name = message.author.name
-        logger.info(f"Chat Request - User: {user}, Server: {guild}, Prompt: {prompt}")
+    guild_id = message.guild.id
-        await message.channel.send(answer)
+    guild_name = message.guild.name if message.guild else "Direct Message"
 
-    if lower.startswith('garfpic '):
+    # IP utils
-        prompt = content[8:]
+    if message.guild and lower.startswith(("garfping ", "garfdns ", "garfhack ")):
-        logger.info(f"Image Request - User: {user}, Server: {guild}, Prompt: {prompt}")
+        await iputils.scan(message, user_name, guild_name, lower)
-        await message.channel.send(f"`Please wait... image generation queued: {prompt}`")
-        await garfield.garfpic(message, prompt)
 
     # Wikipedia
-    if lower.startswith('garfwiki '):
+    if lower.startswith("garfwiki "):
         query = message.content[9:]
         summary = await garfield.wikisum(query)
         await message.channel.send(summary)
 
     # QR codes
-    if lower.startswith('garfqr '):
+    if lower.startswith("garfqr "):
         text = message.content[7:]
         if len(text) > 1000:
             await message.channel.send("❌ Text too long! Maximum 1000 characters.")
@@ -80,47 +80,6 @@ async def on_message(message):
                 logger.error(e)
                 await message.channel.send(e)
 
-    # IP utils
-    query = message.content.split()
-    target = query[-1]
-
-    if lower.startswith("garfping "):
-        try:
-            logger.info(f"Ping Request - User: {user}, Server: {guild}, Target: {target}")
-            if is_private(target):
-                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
-                await message.channel.send(rejection)
-            else:
-                result = subprocess.run(['ping', '-c', '4', target], capture_output=True, text=True)
-                await message.channel.send(f"`Ping result for {target}:`\n```\n{result.stdout}\n```")
-        except Exception as e:
-            await message.channel.send(f"`GarfBot Error: {str(e)}`")
-
-    if lower.startswith("garfdns "):
-        try:
-            logger.info(f"NSLookup Request - User: {user}, Server: {guild}, Target: {target}")
-            if is_private(target):
-                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
-                await message.channel.send(rejection)
-            else:
-                result = subprocess.run(['nslookup', target], capture_output=True, text=True)
-                await message.channel.send(f"`NSLookup result for {target}:`\n```\n{result.stdout}\n```")
-        except Exception as e:
-            await message.channel.send(f"`GarfBot Error: {str(e)}`")
-
-    if lower.startswith("garfhack "):
-        try:
-            logger.info(f"Nmap Request - User: {user}, Server: {guild}, Target: {target}")
-            if is_private(target):
-                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
-                await message.channel.send(rejection)
-            else:
-                await message.channel.send(f"`Scanning {target}...`")
-                result = subprocess.run(['nmap', '-Pn', '-O', '-v', target], capture_output=True, text=True)
-                await message.channel.send(f"`Ping result for {target}:`\n```\n{result.stdout}\n```")
-        except Exception as e:
-            await message.channel.send(f"`GarfBot Error: {str(e)}`")
-
     # Kroger Shopping
     if lower.startswith("garfshop "):
         try:
@@ -130,32 +89,65 @@ async def on_message(message):
         except Exception as e:
             await message.channel.send(f"`GarfBot Error: {str(e)}`")
 
+    # Chats & pics
+    elif lower.startswith("hey garfield") or isinstance(
+        message.channel, discord.DMChannel
+    ):
+        prompt = content[12:] if lower.startswith("hey garfield") else message.content
+        answer = await garfield.generate_chat(prompt)
+        logger.info(
+            f"Chat Request - User: {user_name}, Server: {guild_name}, Prompt: {prompt}"
+        )
+        await message.channel.send(answer)
+
+    elif lower.startswith("garfpic "):
+        prompt = content[8:]
+        logger.info(
+            f"Image Request - User: {user_name}, Server: {guild_name}, Prompt: {prompt}"
+        )
+        await message.channel.send(
+            f"`Please wait... image generation queued: {prompt}`"
+        )
+        await garfield.garfpic(message, prompt)
+
+    # Weather
+    elif lower.startswith("garfbot weather "):
+        location = lower[16:]
+        embed = await weather.weather(location)
+        await message.channel.send(embed=embed)
+
+    # GarfBot help
+    elif lower.strip() == "garfbot help":
+        await help(message)
+
     # Army of Dawn Server only!!
-    if message.guild and message.guild.id == 719605634772893757:
+    elif message.guild and message.guild.id == 719605634772893757:
         await aod_message(garfbot, message)
 
     # Auto-responses
-    if message.guild:
+    elif message.guild:
         responses = garf_respond.get_responses(guild_id)
-        
+
-        if lower.startswith('garfbot response '):
+        if lower.startswith("garfbot response "):
             await garf_respond.garfbot_response(message, content)
             return
-            
+
         for trigger, response in responses.items():
             if trigger.lower() in lower:
                 await message.channel.send(response)
                 break
 
-# Run Garfbot
+
+# Run GarfBot
 async def garfbot_connect():
     while True:
         try:
             await garfbot.start(garfkey)
         except Exception as e:
-                e = str(e)
+            e = str(e)
-                logger.error(f"Garfbot couldn't connect! {e}")
+            logger.error(f"Garfbot couldn't connect! {e}")
-                await asyncio.sleep(60)
+            await asyncio.sleep(60)
+
 
 if __name__ == "__main__":
     asyncio.run(garfbot_connect())

garfpy/__init__.py

@@ -1,10 +1,12 @@
 # garfpy/__init__.py
 
 from .log import logger
+from .help import help
 from .kroger import Kroger
-from .iputils import is_private
-from .aod import aod_message
-from .qr import generate_qr
 from .kroger import Kroger
 from .garfai import GarfAI
-from .respond import GarfbotRespond
+from .respond import GarfbotRespond
+from .aod import aod_message
+from .qr import generate_qr
+from .iputils import IPUtils
+from .weather import WeatherAPI

garfpy/aod.py

@@ -11,6 +11,7 @@ from collections import defaultdict
 meows_file = "meow_counts.json"
 stats_file = "user_stats.json"
 
+
 def json_load(file_path, default):
     if os.path.isfile(file_path):
         with open(file_path, "r") as f:
@@ -18,77 +19,105 @@ def json_load(file_path, default):
     else:
         return default
 
+
 meow_counts = defaultdict(int, json_load(meows_file, {}))
 user_stats = json_load(stats_file, {})
 
+
 async def aod_message(garfbot, message):
-        if "meow" in message.content.lower():
+    if "meow" in message.content.lower():
-            logger.info(f"Meow detected! {message.author.name} said: {message.content}")
+        logger.info(f"Meow detected! {message.author.name} said: {message.content}")
 
-            meow_counts[str(message.author.id)] += 1
+        meow_counts[str(message.author.id)] += 1
 
-            with open(meows_file, "w") as f:
+        with open(meows_file, "w") as f:
-                json.dump(dict(meow_counts), f)
+            json.dump(dict(meow_counts), f)
 
-            if message.content.lower() == "meowcount":
+        if message.content.lower() == "meowcount":
-                response = f"My records show that <@{message.author.id}> has meowed {meow_counts[str(message.author.id)]} time(s). Have a nice day."
+            response = f"My records show that <@{message.author.id}> has meowed {meow_counts[str(message.author.id)]} time(s). Have a nice day."
-                await message.channel.send(response)
+            await message.channel.send(response)
 
-            if message.content.lower() == "top meowers":
+        if message.content.lower() == "top meowers":
-                top_meowers = sorted(meow_counts.items(), key=itemgetter(1), reverse=True)[:10]
+            top_meowers = sorted(meow_counts.items(), key=itemgetter(1), reverse=True)[
-                embed = discord.Embed(title="Top Meowers :cat:", color=0x000000)
+                :10
-                for i, (user_id, meow_count) in enumerate(top_meowers):
+            ]
-                    user = await garfbot.fetch_user(int(user_id))
+            embed = discord.Embed(title="Top Meowers :cat:", color=0x000000)
-                    embed.add_field(name=f"{i+1}. {user.name}", value=f"{meow_count} meows", inline=False)
+            for i, (user_id, meow_count) in enumerate(top_meowers):
-                await message.channel.send(embed=embed)
+                user = await garfbot.fetch_user(int(user_id))
+                embed.add_field(
+                    name=f"{i + 1}. {user.name}",
+                    value=f"{meow_count} meows",
+                    inline=False,
+                )
+            await message.channel.send(embed=embed)
 
-        if message.content.lower() == "checking in":
+    if message.content.lower() == "checking in":
-            user_id = str(message.author.id)
+        user_id = str(message.author.id)
-            if user_id in user_stats and user_stats[user_id]["check_in_time"] is not None:
+        if user_id in user_stats and user_stats[user_id]["check_in_time"] is not None:
-                await message.channel.send(f"{message.author.mention} You are already checked in. Please check out first.")
+            await message.channel.send(
-                return
+                f"{message.author.mention} You are already checked in. Please check out first."
+            )
+            return
 
-            check_in_time = datetime.now().timestamp()
+        check_in_time = datetime.now().timestamp()
-            if user_id not in user_stats:
+        if user_id not in user_stats:
-                user_stats[user_id] = {"check_ins": 0, "total_time": 0, "check_in_time": None}
+            user_stats[user_id] = {
-            user_stats[user_id]["check_in_time"] = check_in_time
+                "check_ins": 0,
-            await message.channel.send(f"{message.author.mention} You have been checked in. Please mute your microphone.")
+                "total_time": 0,
+                "check_in_time": None,
+            }
+        user_stats[user_id]["check_in_time"] = check_in_time
+        await message.channel.send(
+            f"{message.author.mention} You have been checked in. Please mute your microphone."
+        )
 
-        elif message.content.lower() == "checking out":
+    elif message.content.lower() == "checking out":
-            user_id = str(message.author.id)
+        user_id = str(message.author.id)
-            if user_id not in user_stats or user_stats[user_id]["check_in_time"] is None:
+        if user_id not in user_stats or user_stats[user_id]["check_in_time"] is None:
-                await message.channel.send(f"{message.author.mention} You have not checked in yet. Please check in first.")
+            await message.channel.send(
-                return
+                f"{message.author.mention} You have not checked in yet. Please check in first."
+            )
+            return
 
-            check_out_time = datetime.now().timestamp()
+        check_out_time = datetime.now().timestamp()
-            check_in_time = user_stats[user_id]["check_in_time"]
+        check_in_time = user_stats[user_id]["check_in_time"]
-            time_delta = check_out_time - check_in_time
+        time_delta = check_out_time - check_in_time
-            user_stats[user_id]["check_ins"] += 1
+        user_stats[user_id]["check_ins"] += 1
-            user_stats[user_id]["total_time"] += time_delta
+        user_stats[user_id]["total_time"] += time_delta
-            user_stats[user_id]["check_in_time"] = None
+        user_stats[user_id]["check_in_time"] = None
 
-            with open("user_stats.json", "w") as f:
+        with open("user_stats.json", "w") as f:
-                json.dump(user_stats, f)
+            json.dump(user_stats, f)
-            await message.channel.send(f"{message.author.mention} You have been checked out. Your session was {time_delta:.2f} seconds.")
+        await message.channel.send(
+            f"{message.author.mention} You have been checked out. Your session was {time_delta:.2f} seconds."
+        )
 
-        elif message.content.lower() == "stats":
+    elif message.content.lower() == "stats":
-            stats_embed = discord.Embed(title="User stats  :trophy:", color=0x000000)
+        stats_embed = discord.Embed(title="User stats  :trophy:", color=0x000000)
-            sorted_user_stats = sorted(user_stats.items(), key=lambda x: x[1]["total_time"], reverse=True)
+        sorted_user_stats = sorted(
-            table_rows = [["Name", "Check-ins", "Total Time"]]
+            user_stats.items(), key=lambda x: x[1]["total_time"], reverse=True
-            for user_id, stats in sorted_user_stats:
+        )
-                if stats["check_in_time"] is None:
+        table_rows = [["Name", "Check-ins", "Total Time"]]
-                    total_time_seconds = stats["total_time"]
+        for user_id, stats in sorted_user_stats:
-                    hours, total_time_seconds = divmod(total_time_seconds, 3600)
+            if stats["check_in_time"] is None:
-                    minutes, total_time_seconds = divmod(total_time_seconds, 60)
+                total_time_seconds = stats["total_time"]
-                    seconds, fractions = divmod(total_time_seconds, 1)
+                hours, total_time_seconds = divmod(total_time_seconds, 3600)
-                    fractions_str = f"{fractions:.3f}"[2:]
+                minutes, total_time_seconds = divmod(total_time_seconds, 60)
-                    username = garfbot.get_user(int(user_id)).name
+                seconds, fractions = divmod(total_time_seconds, 1)
-                    table_rows.append([username, str(stats["check_ins"]), f"{int(hours)}h {int(minutes)}m {int(seconds)}s {fractions_str}ms"])
+                fractions_str = f"{fractions:.3f}"[2:]
-                else:
+                username = garfbot.get_user(int(user_id)).name
-                    username = garfbot.get_user(int(user_id)).name
+                table_rows.append(
-                    table_rows.append([username, "Currently checked in", "-"])
+                    [
-            table_columns = list(zip(*table_rows[1:]))
+                        username,
-            table_fields = table_rows[0]
+                        str(stats["check_ins"]),
-            for field, values in zip(table_fields, table_columns):
+                        f"{int(hours)}h {int(minutes)}m {int(seconds)}s {fractions_str}ms",
-                stats_embed.add_field(name=field, value="\n".join(values), inline=True)
+                    ]
-            await message.channel.send(embed=stats_embed)
+                )
+            else:
+                username = garfbot.get_user(int(user_id)).name
+                table_rows.append([username, "Currently checked in", "-"])
+        table_columns = list(zip(*table_rows[1:]))
+        table_fields = table_rows[0]
+        for field, values in zip(table_fields, table_columns):
+            stats_embed.add_field(name=field, value="\n".join(values), inline=True)
+        await message.channel.send(embed=stats_embed)

garfpy/garfai.py

@@ -17,16 +17,13 @@ class GarfAI:
         self.image_request_queue = asyncio.Queue()
 
     async def garfpic(self, message, prompt):
-        await self.image_request_queue.put({'message': message, 'prompt': prompt})
+        await self.image_request_queue.put({"message": message, "prompt": prompt})
 
     async def generate_image(self, prompt):
         try:
-            client = AsyncOpenAI(api_key = self.openaikey)
+            client = AsyncOpenAI(api_key=self.openaikey)
             response = await client.images.generate(
-                model=self.imgmodel,
+                model=self.imgmodel, prompt=prompt, n=1, size="1024x1024"
-                prompt=prompt,
-                n=1,
-                size="1024x1024"
             )
             image_url = response.data[0].url
             return image_url
@@ -37,25 +34,25 @@ class GarfAI:
             return f"`GarfBot Error: ({e.status_code}) - Monday`"
         except Exception as e:
             logger.error(e)
-            return f"`GarfBot Error: Lasagna`"
+            return "`GarfBot Error: Lasagna`"
 
     async def process_image_requests(self):
         async with aiohttp.ClientSession() as session:
             while True:
                 request = await self.image_request_queue.get()
-                message = request['message']
+                message = request["message"]
-                prompt = request['prompt']
+                prompt = request["prompt"]
                 image_url = await self.generate_image(prompt)
                 if "GarfBot Error" not in image_url:
                     logger.info("Downloading & sending image...")
                     async with session.get(image_url) as resp:
                         if resp.status == 200:
                             image_data = await resp.read()
-                            ram_image = io.BytesIO(image_data)
+                            image = io.BytesIO(image_data)
-                            ram_image.seek(0)
+                            image.seek(0)
-                            timestamp = message.created_at.strftime('%Y%m%d%H%M%S')
+                            timestamp = message.created_at.strftime("%Y%m%d%H%M%S")
                             filename = f"{timestamp}_generated_image.png"
-                            sendfile = discord.File(fp=ram_image, filename=filename)
+                            sendfile = discord.File(fp=image, filename=filename)
                             try:
                                 await message.channel.send(file=sendfile)
                             except Exception as e:
@@ -69,14 +66,17 @@ class GarfAI:
 
     async def generate_chat(self, question):
         try:
-            client = AsyncOpenAI(api_key = self.openaikey)
+            client = AsyncOpenAI(api_key=self.openaikey)
             response = await client.chat.completions.create(
                 model=self.txtmodel,
                 messages=[
-                    {"role": "system", "content": "Pretend you are sarcastic Garfield."},
+                    {
-                    {"role": "user", "content": f"{question}"}
+                        "role": "system",
+                        "content": "Pretend you are sarcastic Garfield.",
+                    },
+                    {"role": "user", "content": f"{question}"},
                 ],
-                max_tokens=400
+                max_tokens=400,
             )
             answer = response.choices[0].message.content
             return answer.replace("an AI language model", "a cartoon animal")
@@ -84,15 +84,17 @@ class GarfAI:
             return f"`GarfBot Error: {e}`"
         except openai.APIError as e:
             logger.info(e, flush=True)
-            return f"`GarfBot Error: Monday`"
+            return "`GarfBot Error: Monday`"
         except Exception as e:
             logger.info(e, flush=True)
-            return f"`GarfBot Error: Lasagna`"
+            return "`GarfBot Error: Lasagna`"
 
     async def wikisum(self, query):
         try:
             summary = wikipedia.summary(query)
-            garfsum = await self.generate_chat(f"Please summarize in your own words: {summary}")
+            garfsum = await self.generate_chat(
+                f"Please summarize in your own words: {summary}"
+            )
             return garfsum
         except Exception as e:
-            return e
+            return e

garfpy/help.py

@@ -0,0 +1,60 @@
+import discord
+
+
+async def help(message):
+    embed = discord.Embed(title="**Need help?**", color=0x4D4D4D)
+    embed.add_field(
+        name="hey garfield `prompt`", value="*Responds with text.*", inline=True
+    )
+    embed.add_field(
+        name="garfpic `prompt`", value="*Responds with an image.*", inline=True
+    )
+    embed.add_field(
+        name="garfping `target`",
+        value="*Responds with iputils-ping result from target.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfdns `target`",
+        value="*Responds with dns lookup result from target.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfhack `target`",
+        value="*Responds with nmap scan result from target.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfwiki `query`",
+        value="*Garfbot looks up a wikipedia article and will summarize it for you.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfshop `item` `zip`",
+        value="*Responds with 10 grocery items from the nearest Kroger location, cheapest first.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfqr `text`",
+        value="*Create a QR code for any string up to 1000 characters.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfbot response `add` `trigger` `response`",
+        value='*Add a GarfBot auto response for your server. Use "quotes" if you like.*',
+        inline=True,
+    )
+    embed.add_field(
+        name="garfbot response `remove` `trigger`",
+        value="*Remove a GarfBot auto response for your server.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfbot response `list`",
+        value="*List current GarfBot auto responses for your server.*",
+        inline=True,
+    )
+    embed.add_field(
+        name="garfbot help", value="*Show a list of these commands.*", inline=True
+    )
+    await message.channel.send(embed=embed)

garfpy/iputils.py

@@ -1,19 +1,85 @@
+import discord
 import ipaddress
+import subprocess
+from garfpy import logger
 
-def is_private(target):
+
-    try:
+class IPUtils:
-        ip_obj = ipaddress.ip_address(target)
+    def is_private(self, target):
-        if ip_obj.is_private:
+        try:
-            return True
+            ip_obj = ipaddress.ip_address(target)
-    except ValueError:
+            if ip_obj.is_private:
-        if "crate.lan" in target.lower():
+                return True
-            return True
+        except ValueError:
-        if "crate.zip" in target.lower():
+            if "crate.lan" in target.lower():
-            return True
+                return True
-        if "memtec.org" in target.lower():
+            if "crate.zip" in target.lower():
-            return True
+                return True
-        if "crateit.net" in target.lower():
+            if "memtec.org" in target.lower():
-            return True
+                return True
-        if "garfbot.art" in target.lower():
+            if "crateit.net" in target.lower():
-            return True
+                return True
-    return False
+            if "garfbot.art" in target.lower():
+                return True
+        return False
+
+    async def scan(self, message, user, guild, query):
+        split = query.split()
+        target = split[-1]
+        if self.is_private(target):
+            return
+
+        if query.startswith("garfping "):
+            try:
+                logger.info(
+                    f"Ping Request - User: {user}, Server: {guild}, Target: {target}"
+                )
+                await message.channel.send(f"`Pinging {target}...`")
+                result = subprocess.run(
+                    ["ping", "-c", "4", target], capture_output=True, text=True
+                )
+                embed = discord.Embed(
+                    title=f"Ping result: {target}",
+                    color=0x4D4D4D,
+                    description=f"```{result.stdout}```",
+                )
+                await message.channel.send(embed=embed)
+            except Exception as e:
+                await message.channel.send(f"`GarfBot Error: {str(e)}`")
+
+        if query.startswith("garfdns "):
+            try:
+                logger.info(
+                    f"NSLookup Request - User: {user}, Server: {guild}, Target: {target}"
+                )
+                await message.channel.send(f"`Requesting {target}...`")
+                result = subprocess.run(
+                    ["nslookup", target], capture_output=True, text=True
+                )
+                embed = discord.Embed(
+                    title=f"NSLookup result: {target}",
+                    color=0x4D4D4D,
+                    description=f"```{result.stdout}```",
+                )
+                await message.channel.send(embed=embed)
+            except Exception as e:
+                await message.channel.send(f"`GarfBot Error: {str(e)}`")
+
+        if query.startswith("garfhack "):
+            try:
+                logger.info(
+                    f"Nmap Request - User: {user}, Server: {guild}, Target: {target}"
+                )
+                await message.channel.send(f"`Scanning {target}...`")
+                result = subprocess.run(
+                    ["nmap", "-Pn", "-O", "-v", target], capture_output=True, text=True
+                )
+                embed = discord.Embed(
+                    title=f"Nmap scan result: {target}",
+                    color=0x4D4D4D,
+                    description=f"```{result.stdout}```",
+                )
+                embed.set_footer(text="https://nmap.org/")
+                await message.channel.send(embed=embed)
+            except Exception as e:
+                await message.channel.send(f"`GarfBot Error: {str(e)}`")

garfpy/kroger.py

@@ -8,44 +8,51 @@ class Kroger:
     def __init__(self):
         self.client_id = config.CLIENT_ID
         self.client_secret = config.CLIENT_SECRET
-        self.auth = b64encode(f"{self.client_id}:{self.client_secret}".encode()).decode()
+        self.auth = b64encode(
+            f"{self.client_id}:{self.client_secret}".encode()
+        ).decode()
 
     def kroger_token(self):
         headers = {
-            'Content-Type': 'application/x-www-form-urlencoded',
+            "Content-Type": "application/x-www-form-urlencoded",
-            'Authorization': f'Basic {self.auth}'
+            "Authorization": f"Basic {self.auth}",
         }
 
-        response = requests.post('https://api.kroger.com/v1/connect/oauth2/token', headers=headers, data={
+        response = requests.post(
-            'grant_type': 'client_credentials',
+            "https://api.kroger.com/v1/connect/oauth2/token",
-            'scope': 'product.compact'
+            headers=headers,
-        })
+            data={"grant_type": "client_credentials", "scope": "product.compact"},
+        )
 
         response.raise_for_status()
-        return response.json()['access_token']
+        return response.json()["access_token"]
 
     def find_store(self, zipcode, kroken):
         headers = {
-            'Authorization': f'Bearer {kroken}',
+            "Authorization": f"Bearer {kroken}",
         }
         params = {
-            'filter.zipCode.near': zipcode,
+            "filter.zipCode.near": zipcode,
-            'filter.limit': 1,
+            "filter.limit": 1,
         }
-        response = requests.get('https://api.kroger.com/v1/locations', headers=headers, params=params)
+        response = requests.get(
+            "https://api.kroger.com/v1/locations", headers=headers, params=params
+        )
         return response.json()
 
     def search_product(self, product, loc_id, kroken):
         logger.info(f"Searching for {product}...")
         headers = {
-            'Authorization': f'Bearer {kroken}',
+            "Authorization": f"Bearer {kroken}",
         }
         params = {
-            'filter.term': product,
+            "filter.term": product,
-            'filter.locationId': loc_id,
+            "filter.locationId": loc_id,
-            'filter.limit': 10
+            "filter.limit": 10,
         }
-        response = requests.get('https://api.kroger.com/v1/products', headers=headers, params=params)
+        response = requests.get(
+            "https://api.kroger.com/v1/products", headers=headers, params=params
+        )
         return response.json()
 
     def garfshop(self, query):
@@ -55,15 +62,17 @@ class Kroger:
             product = query[-2]
             zipcode = query[-1]
             loc_data = self.find_store(zipcode, kroken)
-            loc_id = loc_data['data'][0]['locationId']
+            loc_id = loc_data["data"][0]["locationId"]
-            store_name = loc_data['data'][0]['name']
+            store_name = loc_data["data"][0]["name"]
             product_query = self.search_product(product, loc_id, kroken)
-            products = product_query['data']
+            products = product_query["data"]
-            sorted_products = sorted(products, key=lambda item: item['items'][0]['price']['regular'])
+            sorted_products = sorted(
+                products, key=lambda item: item["items"][0]["price"]["regular"]
+            )
             response = f"Prices for `{product}` at `{store_name}` near `{zipcode}`:\n"
             for item in sorted_products:
-                product_name = item['description']
+                product_name = item["description"]
-                price = item['items'][0]['price']['regular']
+                price = item["items"][0]["price"]["regular"]
                 response += f"- `${price}`: {product_name} \n"
             return response
         except Exception as e:

garfpy/log.py

@@ -1,19 +1,18 @@
 import logging
 from logging.handlers import TimedRotatingFileHandler
 
-logger = logging.getLogger('garflog')
+logger = logging.getLogger("garflog")
 logger.setLevel(logging.INFO)
-formatter=logging.Formatter(
+formatter = logging.Formatter(
-    '%(asctime)s [%(levelname)s] %(message)s',
+    "%(asctime)s [%(levelname)s] %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
-    datefmt='%Y-%m-%d %H:%M:%S'
+)
-    )
 file_handler = TimedRotatingFileHandler(
-    'garfbot.log',
+    "garfbot.log",
-    when='midnight',
+    when="midnight",
     interval=1,
     backupCount=7,
-    delay=True # Counter-intuitively, this will flush output immediately
+    delay=True,  # Counter-intuitively, this will flush output immediately
-    )
+)
 file_handler.setFormatter(formatter)
 console_handler = logging.StreamHandler()
 console_handler.setFormatter(formatter)

garfpy/qr.py

@@ -4,7 +4,7 @@ from io import BytesIO
 
 def calculate_qr_settings(text):
     text_length = len(text)
-    
+
     if text_length <= 25:
         version = 1
         box_size = 12
@@ -38,26 +38,27 @@ def calculate_qr_settings(text):
     else:
         version = None
         box_size = 3
-    
+
     return version, box_size
 
+
 async def generate_qr(text):
     version, box_size = calculate_qr_settings(text)
-    
+
     qr = qrcode.QRCode(
         version=version,
         error_correction=qrcode.constants.ERROR_CORRECT_L,
         box_size=box_size,
         border=4,
     )
-    
+
     qr.add_data(text)
     qr.make(fit=True)
-    
+
     qr_image = qr.make_image(fill_color="black", back_color="white")
-    
+
     img_buffer = BytesIO()
-    qr_image.save(img_buffer, format='PNG')
+    qr_image.save(img_buffer, format="PNG")
     img_buffer.seek(0)
 
-    return img_buffer
+    return img_buffer

garfpy/respond.py

@@ -7,157 +7,159 @@ import re
 
 class GarfbotRespond:
     def __init__(self):
-        self.guild_responses = {}
+        self.garfbot_responses = {}
-        self.responses_file = 'responses.json'
+        self.responses_file = "responses.json"
 
     def load_responses(self):
         if os.path.exists(self.responses_file):
             try:
-                with open(self.responses_file, 'r', encoding='utf-8') as f:
+                with open(self.responses_file, "r", encoding="utf-8") as f:
-                    self.guild_responses = json.load(f)
+                    self.garfbot_responses = json.load(f)
-                self.guild_responses = {int(k): v for k, v in self.guild_responses.items()}
+                self.garfbot_responses = {
-                total_responses = sum(len(responses) for responses in self.guild_responses.values())
+                    int(k): v for k, v in self.garfbot_responses.items()
-                logger.info(f"Loaded responses for {len(self.guild_responses)} server(s), ({total_responses} total responses)")
+                }
+                total_responses = sum(
+                    len(responses) for responses in self.garfbot_responses.values()
+                )
+                logger.info(
+                    f"Loaded responses for {len(self.garfbot_responses)} server(s), ({total_responses} total responses)"
+                )
             except Exception as e:
                 logger.info(f"Error loading responses: {e}")
-                self.guild_responses = {}
+                self.garfbot_responses = {}
         else:
-            self.guild_responses = {}
+            self.garfbot_responses = {}
 
     def save_responses(self):
         try:
-            save_data = {str(k): v for k, v in self.guild_responses.items()}
+            save_data = {str(k): v for k, v in self.garfbot_responses.items()}
-            with open(self.responses_file, 'w', encoding='utf-8') as f:
+            with open(self.responses_file, "w", encoding="utf-8") as f:
                 json.dump(save_data, f, indent=2, ensure_ascii=False)
-            total_responses = sum(len(responses) for responses in self.guild_responses.values())
+            total_responses = sum(
-            logger.info(f"Saved responses for {len(self.guild_responses)} servers ({total_responses} total responses)")
+                len(responses) for responses in self.garfbot_responses.values()
+            )
+            logger.info(
+                f"Saved responses for {len(self.garfbot_responses)} servers ({total_responses} total responses)"
+            )
         except Exception as e:
             logger.info(f"Error saving responses: {e}")
 
     def get_responses(self, guild_id):
-        if guild_id not in self.guild_responses:
+        if guild_id not in self.garfbot_responses:
-            self.guild_responses[guild_id] = {}
+            self.garfbot_responses[guild_id] = {}
-        return self.guild_responses[guild_id]
+        return self.garfbot_responses[guild_id]
 
     async def garfbot_response(self, message, content):
         guild_id = message.guild.id
 
         logger.info(message.content)
-        
+
         match = re.search(r'garfbot response add "(.+)" "(.+)"', content, re.IGNORECASE)
         if match:
             trigger = match.group(1)
             response_text = match.group(2)
             await self.add_response(message, guild_id, trigger, response_text)
             return
-        
+
-        match = re.search(r'garfbot response add (\S+) (.+)', content, re.IGNORECASE)
+        match = re.search(r"garfbot response add (\S+) (.+)", content, re.IGNORECASE)
         if match:
-            trigger = match.group(1) 
+            trigger = match.group(1)
             response_text = match.group(2)
             await self.add_response(message, guild_id, trigger, response_text)
             return
-        
+
-        match = re.search(r'garfbot\s+response\s+remove\s+(.+)', content, re.IGNORECASE)
+        match = re.search(r"garfbot\s+response\s+remove\s+(.+)", content, re.IGNORECASE)
         if match:
             trigger = match.group(1).strip()
             await self.remove_response(message, guild_id, trigger)
             return
-        
+
         if content.lower() == "garfbot response list":
             await self.list_responses(message, guild_id)
             return
-        
+
         await message.channel.send(
             "**Garfbot Auto-Response Commands:**\n"
-            "`garfbot response add \"trigger\" \"response\"`\n"
+            '`garfbot response add "trigger" "response"`\n'
-            "`garfbot response remove \"trigger\"`\n"
+            '`garfbot response remove "trigger"`\n'
             "`garfbot response list`\n\n"
             "**Examples:**\n"
-            "`garfbot response add \"hi\" \"Hello there!\"`\n"
+            '`garfbot response add "hi" "Hello there!"`\n'
-            "`garfbot response add \"that's what\" \"That's what she said!\"`\n"
+            '`garfbot response add "that\'s what" "That\'s what she said!"`\n'
-            "`garfbot response remove \"hi\"`"
+            '`garfbot response remove "hi"`'
         )
 
     async def add_response(self, message, guild_id, trigger, response_text):
         if not response_text or not trigger:
             await message.channel.send("❌ Trigger and response must not be null.")
             return
-        
+
         responses = self.get_responses(guild_id)
         responses[trigger] = response_text
-        self.guild_responses[guild_id] = responses
+        self.garfbot_responses[guild_id] = responses
         self.save_responses()
-        
+
-        embed = discord.Embed(
+        embed = discord.Embed(title="✅ Auto-response Added.", color=0x00FF00)
-            title="✅ Auto-response Added.",
-            color=0x00ff00
-        )
         embed.add_field(name="Trigger", value=f"`{trigger}`", inline=True)
         embed.add_field(name="Response", value=f"`{response_text}`", inline=True)
         embed.set_footer(text=f"Server: {message.guild.name}")
-        
+
         await message.channel.send(embed=embed)
 
     async def remove_response(self, message, guild_id, trigger):
         responses = self.get_responses(guild_id)
-        
+
         if trigger in responses:
             removed_response = responses[trigger]
             del responses[trigger]
-            self.guild_responses[guild_id] = responses
+            self.garfbot_responses[guild_id] = responses
             self.save_responses()
-            
+
-            embed = discord.Embed(
+            embed = discord.Embed(title="✅ Auto-response Removed.", color=0xFF6B6B)
-                title="✅ Auto-response Removed.",
-                color=0xff6b6b
-            )
             embed.add_field(name="Trigger", value=f"`{trigger}`", inline=True)
             embed.add_field(name="Response", value=f"`{removed_response}`", inline=True)
             embed.set_footer(text=f"Server: {message.guild.name}")
-            
+
             await message.channel.send(embed=embed)
             return
-        
+
         for key in responses.keys():
             if key.lower() == trigger.lower():
                 removed_response = responses[key]
                 del responses[key]
-                self.guild_responses[guild_id] = responses
+                self.garfbot_responses[guild_id] = responses
                 self.save_responses()
-                
+
-                embed = discord.Embed(
+                embed = discord.Embed(title="✅ Auto-response Removed.", color=0xFF6B6B)
-                    title="✅ Auto-response Removed.",
-                    color=0xff6b6b
-                )
                 embed.add_field(name="Trigger", value=f"`{key}`", inline=True)
-                embed.add_field(name="Response", value=f"`{removed_response}`", inline=True)
+                embed.add_field(
+                    name="Response", value=f"`{removed_response}`", inline=True
+                )
                 embed.set_footer(text=f"Server: {message.guild.name}")
-                
+
                 await message.channel.send(embed=embed)
                 return
-        
+
-        await message.channel.send(f"❌ No auto-response found for trigger: `{trigger}`")
+        await message.channel.send(
+            f"❌ No auto-response found for trigger: `{trigger}`"
+        )
 
     async def list_responses(self, message, guild_id):
         responses = self.get_responses(guild_id)
-        
+
         if not responses:
             await message.channel.send("No auto-responses configured for this server.")
             return
-        
+
         embed = discord.Embed(
-            title=f"Auto-Responses for {message.guild.name}",
+            title=f"Auto-Responses for {message.guild.name}", color=0x3498DB
-            color=0x3498db
         )
-        
+
         for i, (trigger, response) in enumerate(responses.items(), 1):
             display_response = response[:50] + "..." if len(response) > 50 else response
             embed.add_field(
-                name=f"{i}. `{trigger}`",
+                name=f"{i}. `{trigger}`", value=f"→ {display_response}", inline=False
-                value=f"→ {display_response}",
-                inline=False
             )
-        
+
         embed.set_footer(text=f"Total responses: {len(responses)}")
         await message.channel.send(embed=embed)

garfpy/weather.py

@@ -0,0 +1,202 @@
+import discord
+import aiohttp
+import config
+from garfpy import logger
+
+
+class WeatherAPI:
+    def __init__(self, api_key=None):
+        self.api_key = api_key or config.WEATHER_TOKEN
+        self.base_url = "https://api.openweathermap.org/data/2.5/weather"
+
+    def parse_location(self, location):
+        location = location.strip().lower()
+
+        if location.isdigit():
+            if len(location) == 5:
+                return {"zip": f"{location},US"}
+            else:
+                return {"zip": location}
+
+        parts = location.split()
+
+        if len(parts) == 1:
+            return {"q": f"{parts[0]},US"}
+
+        elif len(parts) == 2:
+            city, second = parts
+
+            if len(second) == 2 and second.upper() not in [
+                "AK",
+                "AL",
+                "AR",
+                "AZ",
+                "CA",
+                "CO",
+                "CT",
+                "DE",
+                "FL",
+                "GA",
+                "HI",
+                "IA",
+                "ID",
+                "IL",
+                "IN",
+                "KS",
+                "KY",
+                "LA",
+                "MA",
+                "MD",
+                "ME",
+                "MI",
+                "MN",
+                "MO",
+                "MS",
+                "MT",
+                "NC",
+                "ND",
+                "NE",
+                "NH",
+                "NJ",
+                "NM",
+                "NV",
+                "NY",
+                "OH",
+                "OK",
+                "OR",
+                "PA",
+                "RI",
+                "SC",
+                "SD",
+                "TN",
+                "TX",
+                "UT",
+                "VA",
+                "VT",
+                "WA",
+                "WI",
+                "WV",
+                "WY",
+                "DC",
+                "AS",
+                "GU",
+                "MP",
+                "PR",
+                "VI",
+            ]:
+                return {"q": f"{city},{second.upper()}"}
+            else:
+                return {"q": f"{city},{second},US"}
+
+        elif len(parts) == 3:
+            city, state, country = parts
+            return {"q": f"{city},{state},{country.upper()}"}
+
+        else:
+            if len(parts[-1]) == 2:
+                city_parts = parts[:-1]
+                country = parts[-1]
+                city_name = " ".join(city_parts)
+                return {"q": f"{city_name},{country.upper()}"}
+
+            elif len(parts) >= 2 and len(parts[-1]) == 2 and len(parts[-2]) <= 2:
+                city_parts = parts[:-2]
+                state = parts[-2]
+                country = parts[-1]
+                city_name = " ".join(city_parts)
+                return {"q": f"{city_name},{state},{country.upper()}"}
+
+            else:
+                city_name = " ".join(parts)
+                return {"q": f"{city_name},US"}
+
+    async def get_weather(self, location, units="metric"):
+        location_params = self.parse_location(location)
+
+        params = {
+            **location_params,
+            "appid": self.api_key,
+            "units": units,
+        }
+
+        try:
+            async with aiohttp.ClientSession() as session:
+                async with session.get(self.base_url, params=params) as response:
+                    response.raise_for_status()
+                    return await response.json()
+        except aiohttp.ClientError as e:
+            logger.error(f"Error fetching weather data for '{location}': {e}")
+            return None
+
+    def weather_embed(self, weather_data):
+        if not weather_data:
+            embed = discord.Embed(
+                title="❌ Error",
+                description="Could not fetch weather data",
+                color=discord.Color.red(),
+            )
+            return embed
+
+        weather_emojis = {
+            "clear sky": "☀️",
+            "few clouds": "🌤️",
+            "scattered clouds": "⛅",
+            "broken clouds": "☁️",
+            "shower rain": "🌦️",
+            "rain": "🌧️",
+            "thunderstorm": "⛈️",
+            "snow": "❄️",
+            "mist": "🌫️",
+        }
+
+        condition = weather_data["weather"][0]["description"].lower()
+        emoji = weather_emojis.get(condition, "🌍")
+
+        embed = discord.Embed(
+            title=f"{emoji} Weather in {weather_data['name']}",
+            description=f"{weather_data['weather'][0]['description'].title()}",
+            color=discord.Color.blue(),
+        )
+
+        embed.add_field(
+            name="🌡️ Temperature",
+            value=f"{weather_data['main']['temp']}°C\nFeels like {weather_data['main']['feels_like']}°C",
+            inline=True,
+        )
+
+        embed.add_field(
+            name="💧 Humidity",
+            value=f"{weather_data['main']['humidity']}%",
+            inline=True,
+        )
+
+        embed.add_field(
+            name="🗜️ Pressure",
+            value=f"{weather_data['main']['pressure']} hPa",
+            inline=True,
+        )
+
+        if "wind" in weather_data:
+            embed.add_field(
+                name="💨 Wind Speed",
+                value=f"{weather_data['wind']['speed']} m/s",
+                inline=True,
+            )
+
+        if "visibility" in weather_data:
+            embed.add_field(
+                name="👁️ Visibility",
+                value=f"{weather_data['visibility'] / 1000} km",
+                inline=True,
+            )
+
+        embed.set_footer(
+            text=f"Lat: {weather_data['coord']['lat']}, Lon: {weather_data['coord']['lon']}"
+        )
+
+        return embed
+
+    async def weather(self, location):
+        weather_data = await self.get_weather(location)
+        embed = self.weather_embed(weather_data)
+        return embed