Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sarah-marion/news_highlight

This application lists various sources of news and subsequent highlights in each of the source. clicking an individual highlights takes the user to the article itself for the full story
https://github.com/sarah-marion/news_highlight

bootstrap3 flask flask-script news-api python3-6

Last synced: 7 days ago
JSON representation

This application lists various sources of news and subsequent highlights in each of the source. clicking an individual highlights takes the user to the article itself for the full story

Awesome Lists containing this project

README 

        
# News_Highlight



> This application lists various sources of news and subsequent highlights in each of the source. clicking an individual highlights takes the user to the article itself for the full story



## Author



> By **Sarah Marion**



> -----------------------------------------------------------



## Description



> A simple Flask Application that lists various News sources retrieved from [News API](https://newsapi.org/). A user can click on a News source and be directed to a page that contains News Articles from the selected News source. The article's title, image, date of publication and preview will be displayed and a user can click on the article to be directed to the source's site to read the entire article.



## Technologies Used



> * Python3.6

> * Flask framework

> * Bootstrap



## Dependancy Installments



> * pip install python3.6

> * pip install flask

> * pip install flask-bootstrap

> * pip install flask-script



## Technical Requirements



* Contains two classes:- News Source and News Articless

* Contains docstrings to document methods and functions

* Contains test classes for all the classes testing each individual method in a class



## User Stories



As a user I would like:



> * to see various news sources and select the ones I prefer

> * to see all the news articles from that news source

> * to see the image, description and time the news article was created.

> * to click on an article and read it fully from the news source.



## How to use it



> * Internet connection

> * Click https://display-news-highlights.herokuapp.com/) 


  or 


> * Copy https://display-news-highlights.herokuapp.com/) and  Paste the link on your prefered browser



## Specifications



| Behavior        | Input           | Outcome  |

| ------------- |:-------------:| -----:|

| Display News sources | N/A | List of various News sources is displayed |

| Articles from selected News source | **Click** a News source | Directed to a page with a list of articles from the selected source |

| Display image, description, title and date of publish | N/A | An articles image, title, description and date of publication are displayed |

| Read an entire article | **Click** on an article | Directed to the source's site to read the entire article |



## Known Bugs



> It does not have bugs.But if any problems should occur, email me at [email protected]



## Support and Contact Details



> You can reach out to me at [email protected]

for Reviews, Advice, Collaborations and Comments



## Licence



> MIT License



> Copyright (c) 2018 **Dev Sarah Marion**



> Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



> The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.



> --------------------------------------------------------