PaperBot-CLI

Welcome to PaperBot-CLI! This project provides tools to help you find, summarize, and download research papers from arXiv.org based on your topics of interest.

Repository Overview

This repository contains the following Python scripts:

1. arxivScraper.py: A tool to search for and download research papers from arXiv.org.
2. summarizer.py: A tool to summarize research papers using OpenAI's GPT-3.5-turbo model.
3. topics.py: A tool to fetch important research topics and papers based on user interest and skill level using OpenAI's GPT-3.5-turbo model.
4. main.py: The main script that integrates the functionalities of the above tools.
5. fetcher.py: A script that allows a user to download a specific research paper by its name.

Project Structure

.
├── banner.txt
├── fetcher.py
├── main.py
├── summarizer.py
├── topics.py
├── arxivScraper.py
├── requirements.txt
└── .env

Setting Up

1. Clone the Repository

git clone https://github.com/ky13troj/paperbot-CLI.git
cd paperbot-CLI

2. Install Dependencies

Install the required Python packages:

pip install -r requirements.txt

Usage

Running the Main Script

python main.py

This script will:

• Ask for your topic of interest (e.g., Machine Learning) and your skill level (Beginner/Intermediate/Advanced).
• Fetch relevant research topics and papers from arXiv.org.
• Process and clean the fetched papers.
• Summarize a randomly selected paper.
• Ask if you want to download the summarized research paper in PDF format.

Downloading a Specific Research Paper

To download a specific research paper by its name:

python fetcher.py

This script will:

• Prompt you to enter the name of the research paper you want to download.
• Use OpenAI to get the correct name of the research paper.
• Use the ArxivScraper to search and download the paper from arXiv.org.
• summarizes the paper

Future vision

• Discord and Telegram Bot integration
• Daily Research paper recommendation
• Database addition

---

Steps to Get OpenAI API Key :

1.Sign Up for an OpenAI Account

• Go to the OpenAI website.
• Click on the "Sign Up" button to create a new account.

2.Choose a Plan

• After signing up, choose a plan that suits your needs. OpenAI offers different plans based on usage and features.
• You can find more information about the plans here.

3.Access API Key

• Once you have chosen a plan and completed the payment (if applicable), log in to your OpenAI account.
• Go to the API section or dashboard in your account settings.
• You should find your API key listed there. It will typically be a long string of characters.

4.Copy API Key

• Copy your API key to use it in your projects.
• Make sure to keep your API key secure and do not share it publicly.

---

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Contact

For any questions or suggestions, feel free to reach out to me via my social media accounts.

---

V 0.02

1. **Added the New fetcher.py
2. Removed the Step to Create .env File: The step to manually create the .env file has been removed since it is now created automatically by main.py and fetcher.py.
3. Formatted the README: Ensured consistent formatting for better readability.

---

Thank you for using PaperBot-CLI! Happy researching!