Completed New York Times Best Sellers List

.gitignore

@@ -0,0 +1 @@
+.env

app.py

@@ -1,39 +1,15 @@
-from smolagents import CodeAgent,DuckDuckGoSearchTool, HfApiModel,load_tool,tool
+from smolagents import CodeAgent,DuckDuckGoSearchTool, HfApiModel,load_tool,tool, FinalAnswerTool
 import datetime
 import requests
 import pytz
 import yaml
-from tools.final_answer import FinalAnswerTool
+from tools.book_search import NYTBestSellerTool
 
 from Gradio_UI import GradioUI
 
 # Below is an example of a tool that does nothing. Amaze us with your creativity !
-@tool
-def my_custom_tool(arg1:str, arg2:int)-> str: #it's import to specify the return type
-    #Keep this format for the description / args / args description but feel free to modify the tool
-    """A tool that does nothing yet 
-    Args:
-        arg1: the first argument
-        arg2: the second argument
-    """
-    return "What magic will you build ?"
-
-@tool
-def get_current_time_in_timezone(timezone: str) -> str:
-    """A tool that fetches the current local time in a specified timezone.
-    Args:
-        timezone: A string representing a valid timezone (e.g., 'America/New_York').
-    """
-    try:
-        # Create timezone object
-        tz = pytz.timezone(timezone)
-        # Get current time in that timezone
-        local_time = datetime.datetime.now(tz).strftime("%Y-%m-%d %H:%M:%S")
-        return f"The current local time in {timezone} is: {local_time}"
-    except Exception as e:
-        return f"Error fetching time for timezone '{timezone}': {str(e)}"
-
 
+nyt_best_seller_tool = NYTBestSellerTool()
 final_answer = FinalAnswerTool()
 
 # If the agent does not answer, the model is overloaded, please use another model or the following Hugging Face Endpoint that also contains qwen2.5 coder:
@@ -46,16 +22,12 @@ model_id='Qwen/Qwen2.5-Coder-32B-Instruct',# it is possible that this model may
 custom_role_conversions=None,
 )
 
-
-# Import tool from Hub
-image_generation_tool = load_tool("agents-course/text-to-image", trust_remote_code=True)
-
 with open("prompts.yaml", 'r') as stream:
     prompt_templates = yaml.safe_load(stream)
     
 agent = CodeAgent(
     model=model,
-    tools=[final_answer], ## add your tools here (don't remove final answer)
+    tools=[nyt_best_seller_tool, final_answer], ## add your tools here (don't remove final answer)
     max_steps=6,
     verbosity_level=1,
     grammar=None,

nyt_tool.ipynb

@@ -1,5 +1,292 @@
 {
- "cells": [],
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "import dotenv\n",
+    "import os\n",
+    "from datetime import datetime\n",
+    "\n",
+    "dotenv.load_dotenv(\".env\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "params = {\n",
+    "    \"api-key\":api_key\n",
+    "}\n",
+    "\n",
+    "result = requests.get(\n",
+    "    \"https://api.nytimes.com/svc/books/v3/lists/names.json\",\n",
+    "    params=params\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "results = result.json()['results']"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'list_name': 'Combined Print and E-Book Fiction',\n",
+       " 'display_name': 'Combined Print & E-Book Fiction',\n",
+       " 'list_name_encoded': 'combined-print-and-e-book-fiction',\n",
+       " 'oldest_published_date': '2011-02-13',\n",
+       " 'newest_published_date': '2025-03-16',\n",
+       " 'updated': 'WEEKLY'}"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "results[0]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\"combined-print-and-e-book-fiction, \"\n",
+      "\"combined-print-and-e-book-nonfiction, \"\n",
+      "\"hardcover-fiction, \"\n",
+      "\"hardcover-nonfiction, \"\n",
+      "\"trade-fiction-paperback, \"\n",
+      "\"paperback-nonfiction, \"\n",
+      "\"advice-how-to-and-miscellaneous, \"\n",
+      "\"childrens-middle-grade-hardcover, \"\n",
+      "\"picture-books, \"\n",
+      "\"series-books, \"\n",
+      "\"young-adult-hardcover, \"\n",
+      "\"audio-fiction, \"\n",
+      "\"audio-nonfiction, \"\n",
+      "\"business-books, \"\n",
+      "\"graphic-books-and-manga, \"\n",
+      "\"mass-market-monthly, \"\n",
+      "\"middle-grade-paperback-monthly, \"\n",
+      "\"young-adult-paperback-monthly, \"\n"
+     ]
+    }
+   ],
+   "source": [
+    "for nyt_list in results:\n",
+    "    if datetime.strptime(nyt_list['newest_published_date'], \"%Y-%m-%d\").year == 2025:\n",
+    "        print('\"' + nyt_list['list_name_encoded'] + ', \"')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 38,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "result = requests.get(\n",
+    "    \"https://api.nytimes.com/svc/books/v3/lists/current/graphic-books-and-manga.json\",\n",
+    "    params=params\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 39,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "list_results = result.json()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 40,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "book_results = result.json()['results']['books']"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 41,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "book_result_str = \"\"\n",
+    "for ix, book_result in enumerate(book_results):\n",
+    "\n",
+    "    rank = book_result.get(\"rank\")\n",
+    "    if rank:\n",
+    "        book_result_str += f\"rank: {rank}\\n\"\n",
+    "\n",
+    "    title = book_result.get(\"title\")\n",
+    "    if title:\n",
+    "        book_result_str += f\"title: {title}\\n\"\n",
+    "\n",
+    "    author = book_result.get(\"author\")\n",
+    "    if author:\n",
+    "        book_result_str += f\"author: {author}\\n\"\n",
+    "\n",
+    "    description = book_result.get(\"description\")\n",
+    "    if description:\n",
+    "        book_result_str += f\"description: {description}\\n\"\n",
+    "\n",
+    "    primary_isbn10 = book_result.get(\"primary_isbn10\")\n",
+    "    if primary_isbn10:\n",
+    "        book_result_str += f\"primary_isbn10: {primary_isbn10}\\n\"\n",
+    "\n",
+    "    primary_isbn13 = book_result.get(\"primary_isbn13\")\n",
+    "    if primary_isbn13:\n",
+    "        book_result_str += f\"primary_isbn13: {primary_isbn13}\\n\"\n",
+    "\n",
+    "    buy_links = book_result.get(\"buy_links\")\n",
+    "    if buy_links:\n",
+    "        book_result_str += f\"buy_links: \"\n",
+    "        for buy_link in buy_links:\n",
+    "            book_result_str += f\"{buy_link.get('name')} {buy_link.get('url')}\\n\"\n",
+    "\n",
+    "    book_result_str += \"=============================\\n\\n\"\n",
+    "\n",
+    "    if ix + 1 == 5:\n",
+    "        break"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 42,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "rank: 1\n",
+      "title: BIG JIM BEGINS\n",
+      "author: Dav Pilkey\n",
+      "description: The 13th book in the Dog Man series. Big Jim has an adventure that brings up the past.\n",
+      "primary_isbn10: 1338896458\n",
+      "primary_isbn13: 9781338896459\n",
+      "buy_links: Amazon https://www.amazon.com/dp/1338896458?tag=thenewyorktim-20\n",
+      "Apple Books https://goto.applebooks.apple/9781338896459?at=10lIEQ\n",
+      "Barnes and Noble https://www.anrdoezrs.net/click-7990613-11819508?url=https%3A%2F%2Fwww.barnesandnoble.com%2Fw%2F%3Fean%3D9781338896459\n",
+      "Books-A-Million https://www.anrdoezrs.net/click-7990613-35140?url=https%3A%2F%2Fwww.booksamillion.com%2Fp%2FBIG%2BJIM%2BBEGINS%2FDav%2BPilkey%2F9781338896459\n",
+      "Bookshop.org https://bookshop.org/a/3546/9781338896459\n",
+      "=============================\n",
+      "\n",
+      "rank: 2\n",
+      "title: THE SCARLET SHEDDER\n",
+      "author: Dav Pilkey\n",
+      "description: The 12th book in the Dog Man series. Dog Man finds himself back on his hind legs after being sprayed by a skunk.\n",
+      "primary_isbn10: 1338896431\n",
+      "primary_isbn13: 9781338896435\n",
+      "buy_links: Amazon https://www.amazon.com/dp/1338896431?tag=thenewyorktim-20\n",
+      "Apple Books https://goto.applebooks.apple/9781338896435?at=10lIEQ\n",
+      "Barnes and Noble https://www.anrdoezrs.net/click-7990613-11819508?url=https%3A%2F%2Fwww.barnesandnoble.com%2Fw%2F%3Fean%3D9781338896435\n",
+      "Books-A-Million https://www.anrdoezrs.net/click-7990613-35140?url=https%3A%2F%2Fwww.booksamillion.com%2Fp%2FTHE%2BSCARLET%2BSHEDDER%2FDav%2BPilkey%2F9781338896435\n",
+      "Bookshop.org https://bookshop.org/a/3546/9781338896435\n",
+      "=============================\n",
+      "\n",
+      "rank: 3\n",
+      "title: DOG MAN\n",
+      "author: Dav Pilkey\n",
+      "description: A dog’s head is combined with a policeman’s body to create this hybrid supercop hound.\n",
+      "primary_isbn10: 1338741039\n",
+      "primary_isbn13: 9781338741032\n",
+      "buy_links: Amazon https://www.amazon.com/dp/1338741039?tag=thenewyorktim-20\n",
+      "Apple Books https://goto.applebooks.apple/9781338741032?at=10lIEQ\n",
+      "Barnes and Noble https://www.anrdoezrs.net/click-7990613-11819508?url=https%3A%2F%2Fwww.barnesandnoble.com%2Fw%2F%3Fean%3D9781338741032\n",
+      "Books-A-Million https://www.anrdoezrs.net/click-7990613-35140?url=https%3A%2F%2Fwww.booksamillion.com%2Fp%2FDOG%2BMAN%2FDav%2BPilkey%2F9781338741032\n",
+      "Bookshop.org https://bookshop.org/a/3546/9781338741032\n",
+      "=============================\n",
+      "\n",
+      "rank: 4\n",
+      "title: ESCAPING PERIL\n",
+      "author: Tui T. Sutherland.\n",
+      "description: The eighth book in the Wings of Fire graphic novel series. Peril's sense of loyalty becomes tested.\n",
+      "primary_isbn10: 1339001233\n",
+      "primary_isbn13: 9781339001234\n",
+      "buy_links: Amazon https://www.amazon.com/dp/1339001233?tag=thenewyorktim-20\n",
+      "Apple Books https://goto.applebooks.apple/9781339001234?at=10lIEQ\n",
+      "Barnes and Noble https://www.anrdoezrs.net/click-7990613-11819508?url=https%3A%2F%2Fwww.barnesandnoble.com%2Fw%2F%3Fean%3D9781339001234\n",
+      "Books-A-Million https://www.anrdoezrs.net/click-7990613-35140?url=https%3A%2F%2Fwww.booksamillion.com%2Fp%2FESCAPING%2BPERIL%2FTui%2BT.%2BSutherland.%2F9781339001234\n",
+      "Bookshop.org https://bookshop.org/a/3546/9781339001234\n",
+      "=============================\n",
+      "\n",
+      "rank: 5\n",
+      "title: TWENTY THOUSAND FLEAS UNDER THE SEA\n",
+      "author: Dav Pilkey\n",
+      "description: The 11th book in the Dog Man series. Piggy returns and the Supa Buddies are sabotaged.\n",
+      "primary_isbn10: 1338801910\n",
+      "primary_isbn13: 9781338801910\n",
+      "buy_links: Amazon https://www.amazon.com/dp/1338801910?tag=thenewyorktim-20\n",
+      "Apple Books https://goto.applebooks.apple/9781338801910?at=10lIEQ\n",
+      "Barnes and Noble https://www.anrdoezrs.net/click-7990613-11819508?url=https%3A%2F%2Fwww.barnesandnoble.com%2Fw%2F%3Fean%3D9781338801910\n",
+      "Books-A-Million https://www.anrdoezrs.net/click-7990613-35140?url=https%3A%2F%2Fwww.booksamillion.com%2Fp%2FTWENTY%2BTHOUSAND%2BFLEAS%2BUNDER%2BTHE%2BSEA%2FDav%2BPilkey%2F9781338801910\n",
+      "Bookshop.org https://bookshop.org/a/3546/9781338801910\n",
+      "=============================\n",
+      "\n",
+      "\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "3737"
+      ]
+     },
+     "execution_count": 42,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "print(book_result_str)\n",
+    "len(book_result_str)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
  "metadata": {
   "kernelspec": {
    "display_name": "agents_env",
@@ -7,8 +294,16 @@
    "name": "python3"
   },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.10.12"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.11"
   }
  },
  "nbformat": 4,

tools/book_search.py

@@ -1,25 +1,120 @@
 import os
+import requests
 from typing import Any, Optional
 from smolagents.tools import Tool
-import duckduckgo_search
 
-class NYTSearchTool(Tool):
-    name = "best_sellers_tool"
+class NYTBestSellerTool(Tool):
+    name = "nyt_best_sellers_tool"
     description = (
         "Performs a search of the New York Times best seller list " 
-        "for a specific genre and returns the best selling books"
+        "for a specific genre and returns the best selling books.\n"
+        "The possible options for genre are:\n"
+        "combined-print-and-e-book-fiction, "
+        "combined-print-and-e-book-nonfiction, "
+        "hardcover-fiction, "
+        "hardcover-nonfiction, "
+        "trade-fiction-paperback, "
+        "paperback-nonfiction, "
+        "advice-how-to-and-miscellaneous, "
+        "childrens-middle-grade-hardcover, "
+        "picture-books, "
+        "series-books, "
+        "young-adult-hardcover, "
+        "audio-fiction, "
+        "audio-nonfiction, "
+        "business-books, "
+        "graphic-books-and-manga, "
+        "mass-market-monthly, "
+        "middle-grade-paperback-monthly, "
+        "young-adult-paperback-monthly."
         )
     
-    inputs = {'genre': {'type': 'string', 'description': 'The genre to search'}}
+    inputs = {
+        'genre': 
+            {'type': 'string', 'description': 'The genre to search'},
+        'limit': 
+            {'type': 'int', 'description': 'The number of results to include'}
+        }
     output_type = "string"
 
     def __init__(self, max_results=10, **kwargs):
         super().__init__()
         self.api_prefix = "https://api.nytimes.com/svc/books/v3/lists/current"
+        self.api_key = os.getenv("NYT_API_KEY")
+        self.possible_genres = [
+            "combined-print-and-e-book-fiction"
+            "combined-print-and-e-book-nonfiction"
+            "hardcover-fiction"
+            "hardcover-nonfiction"
+            "trade-fiction-paperback"
+            "paperback-nonfiction"
+            "advice-how-to-and-miscellaneous"
+            "childrens-middle-grade-hardcover"
+            "picture-books"
+            "series-books"
+            "young-adult-hardcover"
+            "audio-fiction"
+            "audio-nonfiction"
+            "business-books"
+            "graphic-books-and-manga"
+            "mass-market-monthly"
+            "middle-grade-paperback-monthly"
+            "young-adult-paperback-monthly"
+        ]
 
-    def forward(self, query: str) -> str:
-        results = self.ddgs.text(query, max_results=self.max_results)
-        if len(results) == 0:
-            raise Exception("No results found! Try a less restrictive/shorter query.")
-        postprocessed_results = [f"[{result['title']}]({result['href']})\n{result['body']}" for result in results]
-        return "## Search Results\n\n" + "\n\n".join(postprocessed_results)
+    def forward(self, genre: str, limit: int = 5) -> str:
+        if isinstance(limit,str):
+            limit = int(limit)
+
+        if genre not in self.possible_genres:
+            raise Exception(
+                f"{genre} is not a valid genre. Please search by a genre from the list: {self.possible_genres}"
+                )
+
+        result = requests.get(
+            f"https://api.nytimes.com/svc/books/v3/lists/{genre}.json",
+            params={"api-key":self.api_key}
+        )
+        if len(result.status_code) != 200:
+            raise Exception("Error getting the best seller list. Please try again later.")
+        
+        book_results = result.json()['results']['books']
+
+        book_result_str = ""
+        for ix, book_result in enumerate(book_results):
+
+            rank = book_result.get("rank")
+            if rank:
+                book_result_str += f"rank: {rank}\n"
+
+            title = book_result.get("title")
+            if title:
+                book_result_str += f"title: {title}\n"
+
+            author = book_result.get("author")
+            if author:
+                book_result_str += f"author: {author}\n"
+
+            description = book_result.get("description")
+            if description:
+                book_result_str += f"description: {description}\n"
+
+            primary_isbn10 = book_result.get("primary_isbn10")
+            if primary_isbn10:
+                book_result_str += f"primary_isbn10: {primary_isbn10}\n"
+
+            primary_isbn13 = book_result.get("primary_isbn13")
+            if primary_isbn13:
+                book_result_str += f"primary_isbn13: {primary_isbn13}\n"
+
+            buy_links = book_result.get("buy_links")
+            if buy_links:
+                book_result_str += f"buy_links: "
+                for buy_link in buy_links:
+                    book_result_str += f"{buy_link.get('name')} {buy_link.get('url')}\n"
+
+            book_result_str += "=============================\n\n"
+
+            if ix + 1 == limit:
+                break
+        return book_result_str

tools/final_answer.py

@@ -1,14 +0,0 @@
-from typing import Any, Optional
-from smolagents.tools import Tool
-
-class FinalAnswerTool(Tool):
-    name = "final_answer"
-    description = "Provides a final answer to the given problem."
-    inputs = {'answer': {'type': 'any', 'description': 'The final answer to the problem'}}
-    output_type = "any"
-
-    def forward(self, answer: Any) -> Any:
-        return answer
-
-    def __init__(self, *args, **kwargs):
-        self.is_initialized = False

tools/visit_webpage.py

@@ -1,45 +0,0 @@
-from typing import Any, Optional
-from smolagents.tools import Tool
-import requests
-import markdownify
-import smolagents
-
-class VisitWebpageTool(Tool):
-    name = "visit_webpage"
-    description = "Visits a webpage at the given url and reads its content as a markdown string. Use this to browse webpages."
-    inputs = {'url': {'type': 'string', 'description': 'The url of the webpage to visit.'}}
-    output_type = "string"
-
-    def forward(self, url: str) -> str:
-        try:
-            import requests
-            from markdownify import markdownify
-            from requests.exceptions import RequestException
-
-            from smolagents.utils import truncate_content
-        except ImportError as e:
-            raise ImportError(
-                "You must install packages `markdownify` and `requests` to run this tool: for instance run `pip install markdownify requests`."
-            ) from e
-        try:
-            # Send a GET request to the URL with a 20-second timeout
-            response = requests.get(url, timeout=20)
-            response.raise_for_status()  # Raise an exception for bad status codes
-
-            # Convert the HTML content to Markdown
-            markdown_content = markdownify(response.text).strip()
-
-            # Remove multiple line breaks
-            markdown_content = re.sub(r"\n{3,}", "\n\n", markdown_content)
-
-            return truncate_content(markdown_content, 10000)
-
-        except requests.exceptions.Timeout:
-            return "The request timed out. Please try again later or check the URL."
-        except RequestException as e:
-            return f"Error fetching the webpage: {str(e)}"
-        except Exception as e:
-            return f"An unexpected error occurred: {str(e)}"
-
-    def __init__(self, *args, **kwargs):
-        self.is_initialized = False

tools/web_search.py

@@ -1,27 +0,0 @@
-from typing import Any, Optional
-from smolagents.tools import Tool
-import duckduckgo_search
-
-class DuckDuckGoSearchTool(Tool):
-    name = "web_search"
-    description = "Performs a duckduckgo web search based on your query (think a Google search) then returns the top search results."
-    inputs = {'query': {'type': 'string', 'description': 'The search query to perform.'}}
-    output_type = "string"
-
-    def __init__(self, max_results=10, **kwargs):
-        super().__init__()
-        self.max_results = max_results
-        try:
-            from duckduckgo_search import DDGS
-        except ImportError as e:
-            raise ImportError(
-                "You must install package `duckduckgo_search` to run this tool: for instance run `pip install duckduckgo-search`."
-            ) from e
-        self.ddgs = DDGS(**kwargs)
-
-    def forward(self, query: str) -> str:
-        results = self.ddgs.text(query, max_results=self.max_results)
-        if len(results) == 0:
-            raise Exception("No results found! Try a less restrictive/shorter query.")
-        postprocessed_results = [f"[{result['title']}]({result['href']})\n{result['body']}" for result in results]
-        return "## Search Results\n\n" + "\n\n".join(postprocessed_results)