News Api

Built By Samuel Muriuki

Description

The News Api is a web application that displays a list of various news sources. On choosing a news source, it will preview the top news articles of the day. Clicking a news article will redirect the user to read it fully from the news source. It achieves this by using the News API.

You can view the site at:Heroku

User Stories

These are the behaviours/features that the application implements for use by a user.

As a user I would like to:

• See various news sources
• Select the ones they prefer
• See the top news articles from that news source
• See the image, description and time the news article was created
• Click on an article and read it fully from the news source

Specifications

Behaviour	Input	Output
Display news sources	On page load	List of various news sources is displayed in a list
Display tabs with news by category	On Tab link click	Clickable links to open news based on category
Display articles from a news source	Click a news source	Redirected to a page with articles from the source
Display the preview of an article	On page load	Each article displays an image,description and publication date
To Read an entire article	Click an article	Redirected to the news source's site to read the entire article

SetUp / Installation Requirements

Prerequisites

• Python 3.9.10
• pip
• virtualenv

Cloning

• In your terminal:

    $ git clone https://github.com/Samuel-Muriuki/News_Api/
    $ cd NewsPI
  

Running the Application

• Creating the virtual environment

    $ python3.9 -m venv --without-pip News
    $ source News/bin/env
    $ curl https://bootstrap.pypa.io/get-pip.py | python
  

• Installing Flask and other Modules

    $ python3.9 -m pip install flask
    $ python3.9 -m pip install flask_Bootstrap
    $ python3.9 -m pip install flask_script
  

• Setting up the API Key

    To be able to gather article info from the News API you will need an API Key.
  
    * Visit https://newsapi.org/ and register for an API key.
    * In the root directory of the project folder create a file: start.sh
    * Insert the following info into it:
  
            export NEWS_API_KEY='<Your-Api-Key>'
            python3.9 manage.py server
  
    * Insert the API Key you received from News Api where <Your-Api-Key> is.
  

• To run the application, in your terminal:

    $ chmod +x start.sh
    $ ./start.sh
  

Testing the Application

• To run the tests for the class files:

    $ python3.9 manage.py tests
  

Technologies Used

• Python 3.9.10
• Flask 2.0.3
• Werkzeug 2.0.3

License

MIT License

Copyright (c) [2022] [Samuel-Muriuki]

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.

Go Back to the top

Author Bio

Slack Profile - Samuel-Muriuki

Go Back to the top