https://github.com/blacktechx011/openwebresearcher
Open Web Researcher: is a cutting-edge, AI-powered alternative to tools like SearchGPT and Perplexity. It simplifies web research by refining queries, extracting key information, summarizing complex topics, and generating well-structured reports—all delivered in a convenient Markdown format.
https://github.com/blacktechx011/openwebresearcher
ai ai-agents ai-agents-framework artificial-intelligence blacktechx blacktechx011 llm perpexlity python searchgpt web-search-agent websearch
Last synced: 11 months ago
JSON representation
Open Web Researcher: is a cutting-edge, AI-powered alternative to tools like SearchGPT and Perplexity. It simplifies web research by refining queries, extracting key information, summarizing complex topics, and generating well-structured reports—all delivered in a convenient Markdown format.
- Host: GitHub
- URL: https://github.com/blacktechx011/openwebresearcher
- Owner: BlackTechX011
- License: mit
- Created: 2024-12-29T08:05:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-29T09:11:36.000Z (over 1 year ago)
- Last Synced: 2024-12-29T09:25:21.890Z (over 1 year ago)
- Topics: ai, ai-agents, ai-agents-framework, artificial-intelligence, blacktechx, blacktechx011, llm, perpexlity, python, searchgpt, web-search-agent, websearch
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ **Open Web Researcher** ✨
```
██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██████╗ ███████╗███████╗███████╗ █████╗ ██████╗ ██████╗██╗ ██╗███████╗██████╗
██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗ ██╔══██╗██╔════╝██╔════╝██╔════╝██╔══██╗██╔══██╗██╔════╝██║ ██║██╔════╝██╔══██╗
██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝ ██████╔╝█████╗ ███████╗█████╗ ███████║██████╔╝██║ ███████║█████╗ ██████╔╝
██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗ ██╔══██╗██╔══╝ ╚════██║██╔══╝ ██╔══██║██╔══██╗██║ ██╔══██║██╔══╝ ██╔══██╗
╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝ ██║ ██║███████╗███████║███████╗██║ ██║██║ ██║╚██████╗██║ ██║███████╗██║ ██║
╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═╝ ╚═╝╚══════╝╚══════╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝
```
---
## 🌐 **Overview**
**Open Web Researcher** 🤖 is an **AI-powered research companion** that automates web research, delivering concise and insightful reports. Using state-of-the-art **Large Language Models (LLMs)**, this tool refines queries, extracts content, and generates structured reports in Markdown format, making your research process seamless and efficient.
---
## 🌟 **Key Features**
### 🚀 **Automated Web Research**
Perform in-depth, efficient web searches tailored to your queries.
### 📊 **Highly Detailed Report Generation**
Generate comprehensive, structured, and insightful reports effortlessly.
### 🔍 **Deep Dive into Any Topic**
Unlock a profound understanding of complex subjects with expert-level analysis.
### 💾 **Markdown Export**
Create shareable, easy-to-read Markdown reports perfect for collaboration and presentation.
### 💡 **The Best Free, Open-Source Alternative**
A superior, cost-free alternative to tools like SearchGPT and Perplexity.
### 🎯 **...And More!**
Packed with additional features to revolutionize your web research experience.
---
## 🛠️ **Installation**
### 1️⃣ Clone the Repository:
```bash
git clone https://github.com/BlackTechX011/OpenWebResearcher.git
cd OpenWebResearcher
```
### 2️⃣ Install Dependencies:
```bash
pip install -r requirements.txt
```
### 3️⃣ Configure API Keys:
Update `config/settings.py` with your API keys:
```python
# --- Configuration ---
API_KEYS = ["YOUR_FIRST_API_KEY", "YOUR_SECOND_API_KEY"]
FINAL_REPORT_MODEL_API_KEY = "YOUR_FINAL_REPORT_API_KEY"
```
> [!NOTE]
> You can get your API keys from [https://aistudio.google.com/apikey](https://aistudio.google.com/apikey)
---
## 🎮 **Usage**
1. Run the script:
```bash
python OpenWebResearcher.py
```
2. Enter your query when prompted.
3. Relax as Open Web Researcher delivers a beautifully formatted report.
---
## 📊 **How It Works**
```
+-------------------------+
| 🚀 START |
+-------------------------+
👇
+-------------------------+
| 1. QUERY REFINEMENT |
| Expand into |
| subtopics |
+-------------------------+
👇
+-------------------------+
| 2. WEB SEARCH |
| Extensive search |
| per subtopic |
+-------------------------+
👇
+-------------------------+
| 3. CONTENT EXTRACTION |
| Extract essence from |
| relevant pages |
+-------------------------+
👇
+-------------------------+
| 4. SUMMARIZATION |
| Use LLMs for key |
| points |
+-------------------------+
👇
+-------------------------+
| 5. REPORT GENERATION |
| Combine into an |
| insightful report |
+-------------------------+
👇
+-------------------------+
| 6. MARKDOWN EXPORT |
| Deliver in |
| Markdown format |
+-------------------------+
👇
+-------------------------+
| 🎉 END |
+-------------------------+
```
---
## 🤝 **Contributing**
We welcome contributions! 🚀 Follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make changes and commit them.
4. Submit a pull request.
---
## 📜 **License**
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## 📫 **Contact**
- **GitHub:** [BlackTechX011](https://github.com/BlackTechX011)
---
### 🚀 **Let Open Web Researcher transform your research process!**