added function descriptions

This commit is contained in:
Linus E 2022-03-15 14:43:05 +01:00
parent c0d2b8a679
commit 416667adfb

View File

@ -20,20 +20,30 @@ load_dotenv()
# Init # Init
newsapi = NewsApiClient(api_key=os.getenv('NEWS_API_KEY')) newsapi = NewsApiClient(api_key=os.getenv('NEWS_API_KEY'))
# /v2/top-headlines
top_headlines = newsapi.get_top_headlines(q='bitcoin', sources='bbc-news,the-verge', language='en')
# /v2/everything
all_articles = newsapi.get_everything(q='bitcoin', sources='bbc-news,the-verge', domains='bbc.co.uk,techcrunch.com', from_param='2022-03-14', to='2022-03-15', language='en', sort_by='relevancy', page=2)
# /v2/top-headlines/sources # /v2/top-headlines/sources
sources = newsapi.get_sources() sources = newsapi.get_sources()
def get_top_news_by_keyword(keyword): def get_top_news_by_keyword(keyword):
"""get top news to keyword
Args:
keyword (String): keyword for search
Returns:
JSON/dict: dict containing articles
"""
top_headlines = newsapi.get_top_headlines(q=keyword, sources='bbc-news,the-verge,cnn', language='en') top_headlines = newsapi.get_top_headlines(q=keyword, sources='bbc-news,the-verge,cnn', language='en')
return top_headlines return top_headlines
def format_article(article): def format_article(article):
"""format article for messaging (using markdown syntax)
Args:
article (dict): article to format for messaging
Returns:
String: formatted article
"""
sourcename = article["source"]["name"] sourcename = article["source"]["name"]
headline = article["title"] headline = article["title"]
url = article["url"] url = article["url"]