TrafficLens / README.md
KatGaw's picture
Update README.md
9cf8ac8 verified
---
title: TrafficLens
emoji: 📉
colorFrom: pink
colorTo: yellow
sdk: streamlit
sdk_version: 1.37.1 # The latest supported version
---
# TrafficLens - Full-Text Article Analyzer App
**TrafficLens** aggregates and processes full-text articles scraped from various news sources, including Reddit, NewsAPI, GoogleNews, GDELT articles, and Tavily news. The app analyzes the articles, provides a sentiment index, and summarizes the key information about the events discussed in the articles.
## Features:
- **Article Scraping**: The app scrapes articles from multiple news platforms, including Reddit, NewsAPI, GoogleNews, GDELT, and Tavily news.
- **Sentiment Analysis**: Each article is analyzed for sentiment, with a sentiment index indicating whether the tone is positive, negative, or neutral.
- **Summarization**: The app provides concise summaries of the articles, highlighting key information about the events or topics discussed.
- **Comprehensive Insights**: The app generates a report with the sentiment analysis and key information from the article for quick understanding.
## Supported Sources:
- **Reddit**: Full-text articles from various subreddits.
- **NewsAPI**: Aggregated articles from a wide variety of sources.
- **GoogleNews**: Scraped news from Google’s trending stories.
- **GDELT**: Real-time global event data and news monitoring.
- **Tavily News**: Articles from Tavily’s news aggregation service.
## Tasks:
### 1. Scrape Articles:
- The app collects full-text articles from the above sources.
- It processes the text for further analysis.
### 2. Sentiment Analysis:
- The app applies sentiment analysis algorithms to determine the overall tone (positive, negative, neutral) of each article.
- It generates a sentiment index for each article, reflecting the strength of the sentiment.
### 3. Summarize Events:
- The app extracts and summarizes the most important events or key points discussed in each article.
- The summary highlights major happenings and provides a quick overview of the article.
### 4. Display Insights:
- Each article’s sentiment index and summary are displayed, making it easy to analyze and understand the coverage of different topics.
## Output Format:
- **Article Source:** [Name of source, e.g., Reddit, NewsAPI]
- **Title:** [Article title]
- **Sentiment Index:** [Sentiment index created by Transurban]
- **Summary:** [Concise summary of the article's key events]
- **Full Text:** [Link to the full article or the article body]
## Installation:
1. Clone the repository:
```bash
git clone <repository-url>
### 💬 Feedback
For any questions or feedback, please contact kgawthorpe@transurban.com.
🚗 Try it out!