Sirapatrwan commited on
Commit
8b2b5cf
·
verified ·
1 Parent(s): b54ddc8

Upload user_readme.md

Browse files
Files changed (1) hide show
  1. user_readme.md +32 -0
user_readme.md ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Comapany News Summarizer and Sentiment Analyzer
2
+
3
+ This app fetches news articles about a company, analyzes their sentiment, generates a summary, and provides audio in English or Hindi.
4
+
5
+ ## Features
6
+ - News fetching from Google News RSS.
7
+ - Sentiment analysis using Hugging Face `transformers`.
8
+ - Dynamic sentiment summaries.
9
+ - Audio generation in English and Hindi.
10
+ - Streamlit UI with interactive charts.
11
+
12
+
13
+ ## Usage Terms
14
+ - **Developed by Krishna Prakash** ([LinkedIn](https://www.linkedin.com/in/krishnaprakash-profile/)).
15
+ - **Commercial use**: Contact the author for permission.
16
+ - **Attribution**: If you use this code, give credit to Krishna Prakash and link to this repository.
17
+
18
+ ## Local Execution
19
+ - Install dependencies: `pip install -r requirements.txt`
20
+ - Run: `streamlit run app.py`& `python api.py`
21
+
22
+
23
+ ## Files
24
+ - `app.py`: Streamlit frontend.
25
+ - `utils.py`: News fetching, sentiment analysis, TTS logic.
26
+ - `tts.py`: Text-to-speech conversion.
27
+ - `api.py`: FastAPI backend (local use).
28
+ - `requirements.txt`: Dependencies.
29
+ - `.gitignore`: Excludes unnecessary files.
30
+
31
+ ## Contact
32
+ For questions or commercial use, reach out via [LinkedIn](https://www.linkedin.com/in/krishnaprakash-profile/).