Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manishraj27/ml-news-app-backend
https://github.com/manishraj27/ml-news-app-backend
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/manishraj27/ml-news-app-backend
- Owner: manishraj27
- License: mit
- Created: 2024-06-06T14:09:55.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T17:41:28.000Z (5 months ago)
- Last Synced: 2024-06-07T15:57:31.182Z (5 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Here's a sample README.md file for your repository:
**ML News App API**
=====================
**Summerization of My First Machine Learning NLP Project**
This repository contains the API for my first machine learning NLP project, a news aggregator app that fetches news articles from Google News and provides a summary of each article using natural language processing (NLP) techniques.
**Features**
* Fetches news articles from Google News based on topic or search query
* Provides a summary of each article using NLP techniques
* Returns news data in JSON format
**Endpoints**
* `/api/news`: Fetches news articles based on topic or search query
+ Parameters:
- `topic`: Topic or category of news (e.g. "top", "search", "business", etc.)
- `query`: Search query for news articles (required for "search" topic)
- `quantity`: Number of news articles to return (default: 5)
**Implementation**
The API is built using Flask, a Python web framework, and utilizes the following libraries:
* `newspaper`: For fetching and parsing news articles
* `nltk`: For natural language processing and summarization
* `BeautifulSoup`: For parsing HTML content
**Frontend**
The frontend for this API is built using React and can be found at [https://github.com/manishraj27/ml-news-app-frontend](https://github.com/manishraj27/ml-news-app-frontend).
**Running the API**
To run the API, simply execute the following commands in your terminal:
```
pip install -r requirements.txt
```
```
python app.py
```
The API will be available at `http://localhost:8080/api/news`.
**Contributing**
Contributions to this project are welcome! If you have suggestions for improvements, open an issue or submit a pull request.
**License**
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
**Acknowledgments**
- [Flask](https://flask.palletsprojects.com/): Lightweight WSGI web application framework.
- [Newspaper3k](https://newspaper.readthedocs.io/en/latest/): Article scraping and parsing library.
- [Beautiful Soup](https://www.crummy.com/software/BeautifulSoup/): HTML/XML parsing library.
- [React](https://reactjs.org/): JavaScript library for building user interfaces.
For detailed implementation and usage instructions, refer to the project's documentation.
**Note**
This is my first machine learning NLP project, and I'm excited to share it with the community. I'm open to feedback and suggestions on how to improve the API and its functionality.