🕵️‍♂️ ResearchAgent: Your AI-Powered Research Assistant

"Why spend hours researching when you can have an AI do it for you?" 🤖

📊 Execution Counter

Total Research Runs: 0

This counter is automatically updated each time the research agent runs.

Welcome to ResearchAgent - the coolest AI research buddy you never knew you needed! This little digital detective will scour the internet, gather the latest info on any topic you throw at it, and deliver a beautifully formatted summary straight to your Telegram. It's like having a personal research assistant, but without the coffee breaks! ☕

🚀 What Does This Bad Boy Do?

ResearchAgent is your go-to solution for automated research that:

• 🔍 Finds the Best Sources: Uses Google's Gemini AI to discover the most reputable websites for your topic
• 🕸️ Web Scraping Magic: Automatically scrapes content from those websites (like a ninja, but legal!)
• 📝 Smart Summarization: Leverages Gemini's power to create concise, markdown-formatted summaries
• 📚 Historical Archive: Saves timestamped research reports so you can track how topics evolve
• 📱 Telegram Notifications: Pings you on Telegram when your research is ready (because who doesn't love instant gratification?)
• 🔄 GitHub Integration: Perfect for automated workflows and continuous research

🎯 Perfect For:

• 📊 Market Research: Stay updated on crypto, stocks, or any trending topics
• 📰 News Monitoring: Get daily briefings on subjects you care about
• 🎓 Academic Research: Quick overviews for papers or projects
• 💼 Business Intelligence: Monitor industry trends and competitor analysis
• 🤓 Personal Curiosity: Because knowledge is power!

🛠️ Environment Variables Setup

Before your AI research buddy can start working, you need to feed it some secrets! Create a .env file or set these environment variables:

🔑 Required Variables

Variable	Description	Where to Get It
RESEARCH_TOPIC	The topic you want to research	Your brilliant mind! 🧠
GEMINI_API_KEY	Your Google Gemini API key	Google AI Studio

📱 Telegram Notification Variables (Optional but Awesome!)

Variable	Description	Where to Get It
TELEGRAM_BOT_TOKEN	Your Telegram bot token	@BotFather on Telegram
TELEGRAM_CHAT_ID	Your Telegram chat/channel ID	Use @userinfobot
RESEARCH_FILE_URL	(Optional) Public URL to your research file	Your hosting service (GitHub Pages, etc.)

🤖 GitHub Actions Variables (For the Pro Users!)

Variable	Description
GITHUB_OUTPUT	GitHub Actions output file path

🚦 Quick Start Guide

1. Clone this beauty:

   git clone <your-repo-url>
   cd ResearchAgent

2. Install dependencies:

   pip install -r requirements.txt

   Or install manually:

   pip install google-generativeai requests beautifulsoup4 python-telegram-bot

3. Set your environment variables:

   export RESEARCH_TOPIC="AI Technology Trends"
   export GEMINI_API_KEY="your_gemini_api_key_here"
   # Add Telegram vars if you want notifications

4. Run the research agent:

   python research_agent.py

5. Watch the magic happen! ✨

📋 Example Usage

# Research crypto trends
export RESEARCH_TOPIC="Cryptocurrency Market Analysis"
python research_agent.py

# Research AI developments
export RESEARCH_TOPIC="Artificial Intelligence Breakthroughs 2025"
python research_agent.py

# Send results to Telegram
python send_telegram_message.py

📁 What You'll Get

Your research will be saved in multiple formats:

• research/research-doc-DD-MM-YYYY.md - Timestamped historical archive
• research.md - Always up-to-date version for easy linking

🎨 Sample Output

Check out research/.. to see how beautifully formatted your research reports will be! Complete with:

• 📊 Market trends and analysis
• 🏢 Institutional developments
• 📜 Regulatory updates
• 🔧 Technology advancements

🤝 Contributing

Got ideas to make this research agent even more awesome? PRs are welcome! Whether it's:

• 🌐 Adding more data sources
• 🎨 Improving the output format
• 🚀 Performance optimizations
• 🐛 Bug fixes

📄 License

This project is open source and available under the MIT License.

---

Happy Researching! 🎉

Built with ❤️ and lots of ☕ by someone who got tired of manual research - AKA Frostist