https://github.com/theinit01/reddit-summarybot
https://github.com/theinit01/reddit-summarybot
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/theinit01/reddit-summarybot
- Owner: theinit01
- Created: 2024-05-09T12:41:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T18:15:44.000Z (about 2 years ago)
- Last Synced: 2025-02-15T18:37:57.753Z (over 1 year ago)
- Language: Python
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Article Summarizer Bot
Article Summarizer Bot is a Reddit bot designed to automatically summarize news articles and post the summaries as comments on related posts in a subreddit.
## Introduction
This bot was created to assist users in staying informed about news articles posted on a specific subreddit. It scans the content of news articles linked in the subreddit posts, generates concise summaries using Goggle's Gemini, and posts these summaries as comments on the original posts.
## Features
- Automatically scans 'rising' posts in a subreddit for news articles
- Generates summaries of linked news articles
- Posts summaries as comments on relevant posts
## Getting Started
To use the Article Summarizer Bot, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/your-username/article-summarizer-bot.git
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Set up your Reddit and Google Gemini API credentials by creating a `.env` file and adding your credentials:
```plaintext
REDDIT_USERNAME=your_username
REDDIT_PASSWORD=your_password
REDDIT_CLIENT_ID=your_client_id
REDDIT_CLIENT_SECRET=your_client_secret
GOOGLE_API_KEY=your_gemini_key
```
4. Run the bot:
```bash
python main.py
```
## Contributing
Contributions to the Article Summarizer Bot project are welcome! If you find a bug or have a feature request, please open an issue. Pull requests are also appreciated.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.