https://github.com/areebahmeddd/godseye
Automated News Feedback System
https://github.com/areebahmeddd/godseye
claude-ai httpx mongodb plotly render-cloud streamlit
Last synced: about 2 months ago
JSON representation
Automated News Feedback System
- Host: GitHub
- URL: https://github.com/areebahmeddd/godseye
- Owner: areebahmeddd
- License: apache-2.0
- Created: 2024-06-02T11:20:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-08T12:40:27.000Z (7 months ago)
- Last Synced: 2025-04-05T12:51:06.808Z (2 months ago)
- Topics: claude-ai, httpx, mongodb, plotly, render-cloud, streamlit
- Language: Python
- Homepage: https://gods-eye.onrender.com
- Size: 21 MB
- Stars: 25
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Project Description
The automated news feedback system uses web crawlers to create a dataset of news articles, scrape article URLs, and optical character recognition technology to extract content from e-papers. The system is built with the Streamlit framework to generate graphs using the Plotly library for visualization of scraped data.
Additionally, the system includes a chatbot (powered by Gemini API) that provides perspective on the latest news for users and a Chrome extension for real-time fake news detection.
## System Architecture
Data Acquisition
**Web Scraping**: Utilizes the `BeautifulSoup` library along with the `httpx` library to asynchronously scrape news articles from various news sources.
**File Scraping**: Utilizes the `PyTesseract` library for image-to-text conversion and the `PyMuPDF` library for PDF-to-text conversion.
---
Data Analysis
**Gemini API**: Provides sentiment analysis, media analysis, and fake news detection services.
**Database Storage**: Utilizes the `MongoDB` database to store responses from the Gemini API.
---
Data Presentation
**User Interface**: Utilizes the `Streamlit` framework to generate graphs using the `Plotly` library for visualization of scraped data.
**Chrome Extension**: Provides real-time fake news detection on news articles (Manifest V3).
---
## Getting Started
Follow these steps to set up and run the GodsEye software on your local machine, or you can watch the [demo video](https://youtube.com/watch?v=sWd4kOQU9as).
### Installation
1. Clone the repository to your local machine:
```shell
git clone https://github.com/areebahmeddd/GodsEye.git
```
2. Navigate to the project directory:
```shell
cd GodsEye
```
3. Create a virtual environment (optional but recommended):
```shell
python -m venv .venv
```
4. Activate the virtual environment:
- **Windows**:
```shell
.venv\Scripts\activate
```
- **macOS and Linux**:
```shell
source .venv/bin/activate
```
5. Install the project dependencies:
```shell
pip install -r requirements.txt
```
6. Set up the configuration files:
- Create a `secrets.toml` file in the `.streamlit` directory with the following template:
```ini
[admin]
email = "[email protected]"
app_pass = "your_app_password"
[gemini]
api_key = "your_gemini_api_key"
```
7. Set up the Chrome extension:
- Open Chrome and go to `chrome://extensions`.
- Enable "Developer mode" (top right corner).
- Click "Load unpacked" (top left corner).
- Select the `browser-extension` folder in the GodsEye repository.
### Usage
1. Launch the application by clicking the run button in the top right of VS Code, or execute:
```shell
python python-app/app.py
```
2. Using the Browser Extension:
- Navigate to any of the following supported websites:
- https://www.ndtv.com
**NOTE**: The subdomain https://www.ndtvprofit.com is currently unsupported due to a different HTML structure.
- Select and open any article. The browser extension will be displayed on the right side of the screen. Click on the extension icon to access detailed information.
3. For Contributors:
- To apply changes made to the browser extension, visit `chrome://extensions`, click the "Update" button at the top left, and reload the article page to see the updates.
## License
This project is licensed under the [Apache License 2.0](https://github.com/areebahmeddd/GodsEye/blob/main/LICENSE).
## Authors
[Areeb Ahmed](https://github.com/areebahmeddd) and [Shivansh Karan](https://github.com/SpaceTesla)