Skip to content

aziezahmed/newsapi-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

newsapi-cli

PyPI version

A command line application for displaying news headlines, written in Python.

Getting Started

Prerequisites

Installing

Newsapi-cli is on PyPI so it can be installed with pip.

$ pip install newsapi-cli

To upgrade use the -U flag.

$ pip install -U newsapi-cli

Alternatively get the source and install locally.

$ pip install -e ./newsapi-cli/

Adding your API key

To begin you will need to add your API key. If you do not have an API key you can get one free from News API.

$ news api YOUR00API00KEY00GOES00HERE

Using newsapi-cli

Usage:
  news sources
  news <source>
  news search <keyword>
  news -h | --help
  news --version

Display a list of all news sources

$ news sources

Get headlines from a specific source

$ news <source>

Get headlines related to a keyword

$ news search <keyword>

Example

Get news headlines from the bbc-news source.

$ news bbc-news

Get top news headlines for Great Britain.

$ news gb

Get top business news headlines for Great Britain.

$ news gb/business

Get top headlines about apple.

$ news search apple

Built With

Authors

License

This project is licensed under the MIT License