https://github.com/machariamark/newsapi
An application that will keep you up to date with news articles from various sources all over the globe.
https://github.com/machariamark/newsapi
python
Last synced: about 1 year ago
JSON representation
An application that will keep you up to date with news articles from various sources all over the globe.
- Host: GitHub
- URL: https://github.com/machariamark/newsapi
- Owner: MachariaMark
- License: mit
- Created: 2021-09-10T10:09:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-10T15:07:52.000Z (almost 5 years ago)
- Last Synced: 2025-02-02T08:11:19.845Z (over 1 year ago)
- Topics: python
- Language: Python
- Homepage: https://ty-news.herokuapp.com/
- Size: 5.62 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## NEWSAPI
10.09.2021
#### By **Mark Muchiri Macharia**
## Description
This is an application that will help list and preview news articles from various sources.
## Deployed website
This app is live @
## How it works
As a user can ;
* see various news sources on the homepage of the application.
* select a news source and see all news articles from the selected news source in the application.
* see the image, description and the time a news article was created.
* click on an article and read the full article on the source website.
## Behavior driven devlopment (BDD)
| Intention | Action | Behaviour |
| ---------------- |:--------------------:| -------------------------------------------------:|
| sources |displays news sources | user is able to see news sources on the homepage |
| click link |navigates to article | allows user to access the article |
## Installation
Installation for the package can be done via `pip`:
```bash
$ python -m pip install newsapi-python
```
## Usage
After installation, import the client class into your project:
```python
from newsapi import NewsApiClient
```
Initialize the client with your API key:
```python
api = NewsApiClient(api_key='XXXXXXXXXXXXXXXXXXXXXXX')
```
## Setup
* Clone this repo to your desktop
* run this in your terminal "git remove set-url" if you wish to have it into your repository
* create a directory for this project
* run "sudo add-apt-repository ppa:jonathonf/python-3.6" in your terminal to install python followed by "sudo apt-get update" , then "sudo apt-get install python3.6 ".
* install pip which is the flask package manager..
* run "pip install flask to install flask.
* run "atom ." or "code ." in you terminal depending on the text editor you wish to use.
## Known Bugs
No known bugs.
## Technologies Used
* Bootstrap
* Flask framework that is a Python microframework.
* javascript
* awesome & google fonts
## Support and contact details
For feedback contact me through;
* mark.macharia@student.moringaschool.com
* 0759329269
[](https://github.com/mattlisiv/newsapi-python/blob/master/LICENSE.txt)
[](https://pypi.org/project/newsapi-python/)
[](https://pypi.org/project/newsapi-python/)
[](https://pypi.org/project/newsapi-python)
### License
[MITlicense](LICENSE) 2021 **MARK MUCHIRI MACHARIA**