Skip to content

added exclude domain parameter #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattlisiv merged 1 commit into from
Oct 1, 2018
Merged

added exclude domain parameter #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 41 additions & 32 deletions newsapi/newsapi_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,31 @@ def get_top_headlines(self, q=None, sources=None, language=None, country=None, c
page=None):
"""
Returns live top and breaking headlines for a country, specific category in a country, single source, or multiple sources..

Optional parameters:
(str) q - return headlines w/ specific keyword or phrase. For example:
'bitcoin', 'trump', 'tesla', 'ethereum', etc.

(str) sources - return headlines of news sources! some Valid values are:
'bbc-news', 'the-verge', 'abc-news', 'crypto coins news',
'ary news','associated press','wired','aftenposten','australian financial review','axios',
'bbc news','bild','blasting news','bloomberg','business insider','engadget','google news',
'hacker news','info money,'recode','techcrunch','techradar','the next web','the verge' etc.

(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'

(str) country - The 2-letter ISO 3166-1 code of the country you want to get headlines! Valid values are:
'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',
'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',
'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz',
'ph','pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'

(str) category - The category you want to get headlines for! Valid values are:
'business','entertainment','general','health','science','sports','technology'
(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum.
(int) page - Use this to page through the results if the total results found is greater than the page size.

(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum.

(int) page - Use this to page through the results if the total results found is greater than the page size.
"""

# Define Payload
Expand All @@ -50,7 +50,7 @@ def get_top_headlines(self, q=None, sources=None, language=None, country=None, c
else:
raise TypeError('keyword/phrase q param should be a of type str')

# Sources
# Sources
if (sources is not None) and ((country is not None) or (category is not None)):
raise ValueError('cannot mix country/category param with sources param.')

Expand All @@ -61,7 +61,7 @@ def get_top_headlines(self, q=None, sources=None, language=None, country=None, c
else:
raise TypeError('sources param should be of type str')

# Language
# Language
if language is not None:
if type(language) == str:
if language in const.languages:
Expand Down Expand Up @@ -120,36 +120,39 @@ def get_top_headlines(self, q=None, sources=None, language=None, country=None, c

return r.json()

def get_everything(self, q=None, sources=None, domains=None, from_param=None, to=None, language=None,
sort_by=None, page=None, page_size=None):
def get_everything(self, q=None, sources=None, domains=None, exclude_domains=None,
from_param=None, to=None, language=None, sort_by=None, page=None,
page_size=None):
"""
Search through millions of articles from over 5,000 large and small news sources and blogs.

Optional parameters:
(str) q - return headlines w/ specified coin! Valid values are:
'bitcoin', 'trump', 'tesla', 'ethereum', etc

(str) sources - return headlines of news sources! some Valid values are:
'bbc-news', 'the-verge', 'abc-news', 'crypto coins news',
'ary news','associated press','wired','aftenposten','australian financial review','axios',
'bbc news','bild','blasting news','bloomberg','business insider','engadget','google news',
'hacker news','info money,'recode','techcrunch','techradar','the next web','the verge' etc.

(str) domains - A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.

(str) domains - A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.

(str) exclude_domains - A comma_seperated string of domains to be excluded from the search

(str) from_parameter - A date and optional time for the oldest article allowed.
(e.g. 2018-03-05 or 2018-03-05T03:46:15)

(str) to - A date and optional time for the newest article allowed.

(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'

(str) sort_by - The order to sort the articles in. Valid values are: 'relevancy','popularity','publishedAt'

(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum.

(int) page - Use this to page through the results if the total results found is greater than the page size.
(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum.

(int) page - Use this to page through the results if the total results found is greater than the page size.
"""

# Define Payload
Expand All @@ -176,7 +179,13 @@ def get_everything(self, q=None, sources=None, domains=None, from_param=None, to
else:
raise TypeError('domains param should be of type str')

# Search From This Date ...
if exclude_domains is not None:
if isinstance(exclude_domains, str):
payload['excludeDomains'] = exclude_domains
else:
raise TypeError('exclude_domains param should be of type str')

# Search From This Date ...
if from_param is not None:
if type(from_param) == str:
if (len(from_param)) >= 10:
Expand All @@ -190,7 +199,7 @@ def get_everything(self, q=None, sources=None, domains=None, from_param=None, to
else:
raise TypeError('from_param should be of type str')

# ... To This Date
# ... To This Date
if to is not None:
if type(to) == str:
if (len(to)) >= 10:
Expand Down Expand Up @@ -256,22 +265,22 @@ def get_everything(self, q=None, sources=None, domains=None, from_param=None, to
def get_sources(self, category=None, language=None, country=None):
"""
Returns the subset of news publishers that top headlines...

Optional parameters:
(str) category - The category you want to get headlines for! Valid values are:
'business','entertainment','general','health','science','sports','technology'

(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'

(str) country - The 2-letter ISO 3166-1 code of the country you want to get headlines! Valid values are:
'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',
'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',
'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz',
'ph','pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'

(str) category - The category you want to get headlines for! Valid values are:
'business','entertainment','general','health','science','sports','technology'

"""

# Define Payload
Expand Down
5 changes: 5 additions & 0 deletions tests/test_newsapi_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ def test_api_get_everything(self):
with self.assertRaises(TypeError):
self.api.get_everything(domains=domains)

# Raise TypeError is exclude_domains param is not of type str
exclude_domains = 0
with self.assertRaises(TypeError):
self.api.get_everything(exclude_domains=exclude_domains)

# Raise TypeError is from_param param is not of type str
from_param = 0
with self.assertRaises(TypeError):
Expand Down