Merge pull request #3 from PrettyNeet/FeatAPIroute1H

Merging new API (/1h) to price checks

Author: PrettyNeet

assets/images/DiscoBot_transp.png

@@ -1,7 +1,7 @@
 import discord
 from discord.ext import commands
 from discord import app_commands
-from bot.utils.api import fetch_latest_prices
+from bot.utils.api import fetch_latest_prices, fetch_1h_prices
 from data.items import fish
 import pandas as pd
 
@@ -51,7 +51,7 @@ async def select_callback(self, interaction: discord.Interaction, select: discor
                         f"**Cooked Price:** {row['Cooked Price']}\n"
                         f"**Profit:** {int(row['Profit'])}\n"
                         f"**XP/hr:** {row['XP/hr']}\n"
-                        f"**GP/hr:** {row['XP/hr']}\n"
+                        f"**GP/hr:** {row['GP/hr']}\n"
                     ),
                     inline=False
                 )
@@ -63,17 +63,32 @@ def __init__(self, bot):
         self.bot = bot
 
     @app_commands.command(name="fish_profit", description="Calculate the potential profit from cooking fish.")
-    async def fish_profit(self, interaction: discord.Interaction):
-        prices = fetch_latest_prices()
+    @app_commands.choices(
+        price_type=[
+            app_commands.Choice(name="Latest", value="latest"),
+            app_commands.Choice(name="1-hour average", value="1h"),
+        ]
+    )
+    async def fish_profit(self, interaction: discord.Interaction, price_type: app_commands.Choice[str]):
+        if price_type.value == "latest":
+            prices = fetch_latest_prices()
+            price_key = "high"
+        elif price_type.value == "1h":
+            prices = fetch_1h_prices()
+            price_key = "avgHighPrice"
+        else:
+            await self.interaction.followup.send("error in price type selection")
+            return
+            
         cooking_rate = 1435
 
         profit_results = []
         for fish_name, info in fish.items():
             raw_id_str = str(info["raw_id"])
             cooked_id_str = str(info["cooked_id"])
             fish_xp_each = info["xp_each"]
-            raw_price = prices[raw_id_str]["high"]
-            cooked_price = prices[cooked_id_str]["high"]
+            raw_price = prices[raw_id_str][price_key]
+            cooked_price = prices[cooked_id_str][price_key]
 
             if raw_price and cooked_price:
                 profit_fish = cooked_price - raw_price

assets/images/discord bot.png

@@ -2,14 +2,14 @@
 from discord.ext import commands
 from discord import app_commands
 import pandas as pd
-from bot.utils.api import fetch_latest_prices
-from bot.utils.calculations import calculate_custom_profit
+from bot.utils.api import fetch_latest_prices, fetch_1h_prices
+from bot.utils.calculations import calculate_custom_profit, DEBUG
 from data.items import herbs
 
 
 # Setting the VIEW class to handle user format selection, interactive within discord channel message
 class FormatSelectView(discord.ui.View):
-    def __init__(self, bot, interaction, farming_level, patches, weiss, trollheim, hosidius, fortis, kandarin_diary, kourend, magic_secateurs, farming_cape, bottomless_bucket, attas, compost):
+    def __init__(self, bot, interaction, farming_level, patches, weiss, trollheim, hosidius, fortis, kandarin_diary, kourend, magic_secateurs, farming_cape, bottomless_bucket, attas, compost, prices, price_key, price_type):
         super().__init__()
         self.bot = bot
         self.interaction = interaction
@@ -26,6 +26,9 @@ def __init__(self, bot, interaction, farming_level, patches, weiss, trollheim, h
         self.bottomless_bucket = bottomless_bucket
         self.attas = attas
         self.compost = compost
+        self.prices = prices
+        self.price_key = price_key
+        self.price_type = price_type
 
     # Select menu for format, set's the option for the bot to later format the reply
     @discord.ui.select(
@@ -40,13 +43,17 @@ async def select_callback(self, interaction: discord.Interaction, select):
         # Sets the format choice
         format_choice = interaction.data["values"][0]
         await interaction.response.defer()
+        
+        if DEBUG:
+            # Debugging: Print the prices and price_key
+            print("Prices fetched:", self.prices)
+            print("Price key:", self.price_key)
 
-        # Fetch the latest prices and calculate profits
-        latest_prices = fetch_latest_prices()
+        # calculate profits
         profit_results = calculate_custom_profit(
-            latest_prices, herbs, self.farming_level, self.patches, self.weiss,
+            self.prices, herbs, self.farming_level, self.patches, self.weiss,
             self.trollheim, self.hosidius, self.fortis, self.compost, self.kandarin_diary,
-            self.kourend, self.magic_secateurs, self.farming_cape, self.bottomless_bucket, self.attas
+            self.kourend, self.magic_secateurs, self.farming_cape, self.bottomless_bucket, self.attas, self.price_key
         )
 
         # Error handling if API or calc is empty
@@ -59,16 +66,17 @@ async def select_callback(self, interaction: discord.Interaction, select):
         df_sorted = df.sort_values(by="Profit per Run", ascending=False)
 
         # Format and send response based on user choice
+        title = f"results using {self.price_type} prices"
         if format_choice == "markdown":
             table_header = f"{'Herb':<12} {'Seed Price':<12} {'Herb Price':<12} {'Profit per Run':<15}\n{'-'*12} {'-'*12} {'-'*12} {'-'*15}\n"
             table_rows = ""
             for index, row in df_sorted.iterrows():
                 table_rows += f"{row['Herb']:<12} {row['Seed Price']:<12} {row['Grimy Herb Price']:<12} {int(row['Profit per Run']):<15}\n"
-            table = f"```{table_header}{table_rows}```"
+            table = f"```{title}\n{table_header}{table_rows}```"
             await self.interaction.followup.send(content=f"{self.interaction.user.mention} Here are the results:\n{table}")
 
         elif format_choice == "embed":
-            embed = discord.Embed(title="Herb Profit per Run", color=discord.Color.green())
+            embed = discord.Embed(title=title, color=discord.Color.green())
             embed.set_author(name=self.interaction.user.display_name, icon_url=self.interaction.user.display_avatar.url)
             for index, row in df_sorted.iterrows():
                 embed.add_field(
@@ -109,6 +117,10 @@ def __init__(self, bot):
             app_commands.Choice(name="Compost", value="Compost"),
             app_commands.Choice(name="Supercompost", value="Supercompost"),
             app_commands.Choice(name="Ultracompost", value="Ultracompost"),
+        ],
+        price_type=[
+            app_commands.Choice(name="Latest", value="latest"),
+            app_commands.Choice(name="1-hour average", value="1h"),
         ]
     )
     async def herb_profit(
@@ -127,14 +139,29 @@ async def herb_profit(
         bottomless_bucket: bool,
         attas: bool,
         compost: app_commands.Choice[str],
-
+        price_type: app_commands.Choice[str]
     ):
+        if price_type.value == "latest":
+            prices = fetch_latest_prices()
+            price_key = "high"
+        elif price_type.value == "1h":
+            prices = fetch_1h_prices()
+            price_key = "avgHighPrice"
+        else:
+            await self.interaction.followup.send("error is checking price type value")
+            return
+        
+        if DEBUG:
+            # Debugging: Print the prices and price_key
+            print("Prices fetched:", prices)
+            print("Price key:", price_key)
+        
         # Create and send a view select
         view = FormatSelectView(
             bot=self.bot, interaction=interaction, farming_level=farming_level, patches=patches,
             weiss=weiss, trollheim=trollheim, hosidius=hosidius, fortis=fortis, kandarin_diary=kandarin_diary,
             kourend=kourend, magic_secateurs=magic_secateurs, farming_cape=farming_cape, bottomless_bucket=bottomless_bucket, attas=attas,
-            compost=compost.value
+            compost=compost.value, prices=prices, price_key=price_key, price_type=price_type.value
         )
         await interaction.response.send_message("Choose the format for the reply:", view=view)
 

bot/commands/fish_profit.py

@@ -8,6 +8,15 @@ def fetch_latest_prices():
     response = requests.get(url, headers=HEADERS)  # OSRS wiki demands custom user-agent headers, defined in config.yaml. python requests are blocked by default
     data = response.json()
 
+    if "data" not in data:
+        raise ValueError("Error fetching data from API")
+    return data["data"]
+
+
+def fetch_1h_prices():
+    url = "https://prices.runescape.wiki/api/v1/osrs/1h"
+    response = requests.get(url, headers=HEADERS)
+    data = response.json()
     if "data" not in data:
         raise ValueError("Error fetching data from API")
     return data["data"]

bot/commands/herb_profit.py

@@ -3,7 +3,7 @@
 
 
 # Calculate profit based on user inputs and real-time prices
-def calculate_custom_profit(prices, herbs, farming_level, patches, weiss, trollheim, hosidius, fortis, compost, kandarin_diary, kourend, magic_secateurs, farming_cape, bottomless_bucket, attas):
+def calculate_custom_profit(prices, herbs, farming_level, patches, weiss, trollheim, hosidius, fortis, compost, kandarin_diary, kourend, magic_secateurs, farming_cape, bottomless_bucket, attas, price_key):
     # Constants and multipliers
     compost_life_value = {'None': 0, 'Compost': 1, 'Supercompost': 2, 'Ultracompost': 3}
     item_bonus = 0.1 if magic_secateurs else 0
@@ -45,8 +45,15 @@ def calculate_custom_profit(prices, herbs, farming_level, patches, weiss, trollh
         if seed_id_str not in prices or herb_id_str not in prices:
             continue
 
-        seed_price = prices[seed_id_str]["high"]
-        herb_price = prices[herb_id_str]["high"]
+        seed_price = prices[seed_id_str][price_key]
+        herb_price = prices[herb_id_str][price_key]
+        
+        if DEBUG:
+            print(f"price type: {price_key}\n")
+            print(f"Herb: {herb}, Seed Price: {seed_price}, Herb Price: {herb_price}")
+            
+        if seed_price is None or herb_price is None:
+            continue
 
         # Calculate expected yield using detailed mechanics
         expected_yield_unprotected = generate_estimated_yield(

bot/utils/api.py

@@ -1,30 +1,26 @@
 # OSRS Utilities
 
-This is a Discord bot that fetches the latest prices from the Old School Runescape Grand Exchange and calculates the potential profit from herb farming runs. The reason for a different utility than the osrs wiki farm herb calculator is due to the method that it fetches GE prices for items, which does not accurately represent the current price.
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) ![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
 
-## Commands
-
-### Herb Profit
+![GitHub last commit](https://img.shields.io/github/last-commit/PrettyNeet/OSRS_Utilities) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/PrettyNeet/OSRS_Utilities) 
 
-Calculate the potential profit from herb farming runs.
+This Discord bot fetches the latest prices from the Old School Runescape Grand Exchange and calculates potential profits from herb farming runs and cooking fish. Unlike the OSRS Wiki herb calculator, this bot uses a different method to fetch Grand Exchange prices for items, providing more accurate current prices.
 
-Usage:
-```/herb_profit farming_level patches weiss trollheim hosidius fortis kandarin_diary kourend magic_secateurs farming_cape bottomless_bucket compost```
+## Commands
 
-### Fish Profit
+The bot commands are configured in a way that the parameters for the command will be prompted and autofilled by the bot.
 
-Calculate the potential profit from cooking fish.
+```/herb_profit```
 
-Usage:
 ```/fish_profit```
 
-## Roadmap / TODO 📋✨
+## Roadmap 📋✨
 
-Please feel free to submit ideas (as issues) or pull requests for requested/nice to have features
+Feel free to submit ideas (as issues) or pull requests for requested or nice-to-have features. See the projects board for accurate feature/issue tracking.
 
 ### New User Options for Commands 🛠️
 
-- [ ] Allow users to set if they want the latest price or 1h average
+- [x] Allow users to set if they want the latest price or 1h average
 
 ### New Commands 🎣🔥
 
@@ -41,6 +37,8 @@ Please feel free to submit ideas (as issues) or pull requests for requested/nice
 
 ```bash
 osrs_utilities/
+├── assets/
+│   ├── images/
 ├── bot/ 
 │   ├── __init__.py
 │   ├── bot.py 
@@ -101,20 +99,27 @@ osrs_utilities/
 
 3. **Set up environment variables:**
 
-    Create a `.env` file in the root directory and add your Discord bot token:
+    Create a ```.env``` file in the root directory and add your Discord bot token:
 
     ```env
     DISCORD_BOT_TOKEN=your_discord_bot_token
     ```
 
 4. **Configure settings:**
 
-    Update `config.yaml` with any additional settings you need.
+    Update ```config.yaml``` with any additional settings you need.
+
+    ```yaml
+    bot_prefix:
+    intents:
+    headers:
+    debug:
+    ```
 
 5. **Run the bot:**
 
     ```bash
-    python run.py
+    python .\run.py
     ```
 
 ## Installation (Docker)
@@ -143,7 +148,7 @@ osrs_utilities/
 ## Usage
 
 - Add your bot to your Discord server using the OAuth2 URL generated in the Discord Developer Portal.
-- Use the `/herb_profit` command in your Discord server to see the profit data.
+- refer to the command section or bot.py for all commands
 
 ## Debugging
 
@@ -159,10 +164,10 @@ When debugging is enabled, additional information will be printed to the console
 
 To add new commands and features, follow these steps:
 
-1. **Create a new command file (optional):**
+1. **Create a new command file:**
 
 - If you have multiple commands related to a feature, you might want to group them in a separate file.
-- For example, create a file bot/new_feature_commands.py.
+- create the new command file in /commands/ folder
 
 2. **Define the command in the command file:**
 
@@ -171,9 +176,10 @@ To add new commands and features, follow these steps:
 
 3. **Add utility functions (if needed):**
 
-- If the command requires helper functions, add them to bot/utils.py.
+- re-use any of the helper utilities found in the /utils/ folder
+- if a new utility is identified, create one here to be re-used later in new commands
 
-4. **Load the new command in run.py:**
+4. **Load the new command in run.py and/or bot.py:**
 
 - Ensure the new command file is imported and the setup function is called.