📚💡 AI Book Recommender

tl;dr 📝

You give your favorite books, the script fetches books information such as title, genres, and synopsis. All this info is passed to ChatGPT using a prompt template to get the book recommendations.

Table of Contents 🗂️

• 📚AI Book Recommender
  • tl;dr 📝
  • Table of Contents 🗂️
  • Demo 🎥
  • Description 📚
  • Usage 🛠️
    • Requirements ⚙️
    • Getting Started 🚀
  • Configuration ⚙️
  • Contributing 👋
  • License 📜

Demo 🎥

Description 📚

The AI Book Recommender 🤖📚 works by interacting with two main components: Goodreads 📖 for fetching book data, and OpenAI's ChatGPT 🧠 for generating recommendations.

• Goodreads 📖: We're using Goodreads to fetch details about your favorite books 📚, including the book title 🏷️, author 🖋️, genres 🏷️, and synopsis 📝. The script then extracts this data and uses it to generate personalized book recommendations 🎯.

• OpenAI's ChatGPT 🧠: We're using ChatGPT to generate book recommendations based on the book data fetched from Goodreads 📖. We feed ChatGPT with a conversation context 🗨️ where the user talks about their favorite books (the data fetched from Goodreads). The AI then responds with book recommendations 📚 in a conversational manner.

Usage 🛠️

Requirements ⚙️

• Python 3.7 and above 🐍
• An OpenAI API key 🔑
• Git 📚

Here is detailed explanation for installing all the dependencies 🧩.

Getting Started 🚀

1. Clone this repository on your local machine.

git clone https://github.com/decisivedevops/ai-book-recommender.git

2. Navigate to the repository.

cd ai-book-recommender/

3. Create a Python virtual environment and activate it.

python3 -m venv venv
source venv/bin/activate

4. Install the necessary dependencies.

 pip install -r requirements.txt

5. Rename the sample.config.toml file to config.toml:

mv sample.config.toml config.toml

6. Open the config.toml file and update your OpenAI API key in the appropriate field.

7. Update your favorite books info in the config.toml file. Follow the provided format and add the titles and authors of your favorite books.

[books]
favorites = """
Book Title, Author
Book Title, Author
Book Title, Author
"""

8. Run the main.py script:

python3 main.py

9. The script gives reading recommendations based on your favorite books. The suggestions are also saved in the logs folder.

Configuration ⚙️

The configuration file, config.toml, has various settings used by the script:

• OpenAI settings, including the model name, temperature, and API key 🌡️.
• A list of your favorite books 📚.
• Message templates used when interacting with ChatGPT 💌.

Contributing 👋

Contributions are welcome. If you find a bug 🐞 or have an idea for an improvement or new feature, please raise an issue or submit a pull request.

License 📜

AI Book Recommender is open source and available under the MIT License.