rename class (remove _results)

Author: jvmvik

README.md

@@ -25,8 +25,8 @@ pip install google-search-results
 ## Quick start
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({
+from serpapi import GoogleSearch
+search = GoogleSearch({
  "q": "coffee", 
  "location": "Austin,Texas",
  "api_key": "<your secret api key>"
@@ -40,19 +40,19 @@ The SerpApi service (backend)
 - searches on Google using the search: q = "coffee"
 - parses the messy HTML responses
 - return a standardizes JSON response
-The GoogleSearchResults class
+The GoogleSearch class
 - Format the request
 - Execute GET http request against SerpApi service
 - Parse JSON response into a dictionary
 Et voila..
 
 Alternatively, you can search:
-- Bing using BingSearchResults class
-- Baidu using BaiduSearchResults class
-- Yahoo using YahooSearchResults class
-- Ebay using EbaySearchResults class
-- Yandex using YandexSearchResults class
-- GoogleScholar using GoogleScholarSearchResults class
+- Bing using BingSearch class
+- Baidu using BaiduSearch class
+- Yahoo using YahooSearch class
+- Ebay using EbaySearch class
+- Yandex using YandexSearch class
+- GoogleScholar using GoogleScholarSearch class
 
 See the [playground to generate your code.](https://serpapi.com/playground)
 
@@ -106,7 +106,7 @@ params = {
 }
 
 # define the search search
-search = GoogleSearchResults(params)
+search = GoogleSearch(params)
 # override an existing parameter
 search.params_dict["location"] = "Portland"
 # search format return as raw html
@@ -125,11 +125,11 @@ You can get an API key here if you don't already have one: https://serpapi.com/u
 
 The SerpApi `api_key` can be set globally:
 ```python
-GoogleSearchResults.SERP_API_KEY = "Your Private Key"
+GoogleSearch.SERP_API_KEY = "Your Private Key"
 ```
 The SerpApi `api_key` can be provided for each search:
 ```python
-query = GoogleSearchResults({"q": "coffee", "serp_api_key": "Your Private Key"})
+query = GoogleSearch({"q": "coffee", "serp_api_key": "Your Private Key"})
 ```
 
 ### Example by specification
@@ -152,8 +152,8 @@ make test
 ### Location API
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({})
+from serpapi import GoogleSearch
+search = GoogleSearch({})
 location_list = search.get_location("Austin", 3)
 print(location_list)
 ```
@@ -179,8 +179,8 @@ The search result are stored in temporary cached.
 The previous search can be retrieve from the the cache for free.
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+from serpapi import GoogleSearch
+search = GoogleSearch({"q": "Coffee", "location": "Austin,Texas"})
 search_result = search.get_dictionary()
 search_id = search_result.get("search_metadata").get("id")
 print(search_id)
@@ -189,23 +189,23 @@ print(search_id)
 Now let retrieve the previous search from the archive.
 
 ```python
-archived_search_result = GoogleSearchResults({}).get_search_archive(search_id, 'json')
+archived_search_result = GoogleSearch({}).get_search_archive(search_id, 'json')
 print(archived_search_result.get("search_metadata").get("id"))
 ```
 it prints the search result from the archive.
 
 ### Account API
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({})
+from serpapi import GoogleSearch
+search = GoogleSearch({})
 account = search.get_account()
 ```
 it prints your account information.
 
 ### Search Bing
 ```python
-from serpapi import BingSearchResults
-search = BingSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+from serpapi import BingSearch
+search = BingSearch({"q": "Coffee", "location": "Austin,Texas"})
 data = search.get_json()
 ```
 this code prints baidu search results for coffee as JSON. 
@@ -214,17 +214,17 @@ https://serpapi.com/bing-search-api
 
 ### Search Baidu
 ```python
-from serpapi import BaiduSearchResults
-search = BaiduSearchResults({"q": "Coffee"})
+from serpapi import BaiduSearch
+search = BaiduSearch({"q": "Coffee"})
 data = search.get_json()
 ```
 this code prints baidu search results for coffee as JSON. 
 https://serpapi.com/baidu-search-api
 
 ### Search Yandex
 ```python
-from serpapi import YandexSearchResults
-search = YandexSearchResults({"text": "Coffee"})
+from serpapi import YandexSearch
+search = YandexSearch({"text": "Coffee"})
 data = search.get_json()
 ```
 this code prints yandex search results for coffee as JSON. 
@@ -233,8 +233,8 @@ https://serpapi.com/yandex-search-api
 
 ### Search Yahoo
 ```python
-from serpapi import YahooSearchResults
-search = YahooSearchResults({"p": "Coffee"})
+from serpapi import YahooSearch
+search = YahooSearch({"p": "Coffee"})
 data = search.get_json()
 ```
 this code prints yahoo search results for coffee as JSON. 
@@ -244,8 +244,8 @@ https://serpapi.com/yahoo-search-api
 
 ### Search Ebay
 ```python
-from serpapi import EbaySearchResults
-search = EbaySearchResults({"_nkw": "Coffee"})
+from serpapi import EbaySearch
+search = EbaySearch({"_nkw": "Coffee"})
 data = search.get_json()
 ```
 this code prints ebay search results for coffee as JSON. 
@@ -254,8 +254,8 @@ https://serpapi.com/ebay-search-api
 
 ### Search Google Scholar
 ```python
-from serpapi import GoogleScholarSearchResults
-search = GoogleScholarSearchResults({"q": "Coffee"})
+from serpapi import GoogleScholarSearch
+search = GoogleScholarSearch({"q": "Coffee"})
 data = search.get_json()
 ```
 this code prints Google Scholar search results.
@@ -272,8 +272,8 @@ This class enables to interact with any search engine supported by SerpApi.com
 ### Search Google Images
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({"q": "coffe", "tbm": "isch"})
+from serpapi import GoogleSearch
+search = GoogleSearch({"q": "coffe", "tbm": "isch"})
 for image_result in search.get_json()['images_results']:
  link = image_result["original"]
  try:
@@ -292,8 +292,8 @@ https://github.com/serpapi/showcase-serpapi-tensorflow-keras-image-training
 ### Search Google News
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({
+from serpapi import GoogleSearch
+search = GoogleSearch({
  "q": "coffe", # search search
  "tbm": "nws", # news
  "tbs": "qdr:d", # last 24h
@@ -311,8 +311,8 @@ this script prints the first 3 pages of the news title for the last 24h.
 ### Search Google Shopping
 
 ```python
-from serpapi import GoogleSearchResults
-search = GoogleSearchResults({
+from serpapi import GoogleSearch
+search = GoogleSearch({
  "q": "coffe", # search search
  "tbm": "shop", # news
  "tbs": "p_ord:rv", # last 24h
@@ -332,10 +332,10 @@ With SerpApi, we can build Google search from anywhere in the world.
 This code is looking for the best coffee shop per city.
 
 ```python
-from serpapi import GoogleSearchResults
+from serpapi import GoogleSearch
 for city in ["new york", "paris", "berlin"]:
- location = GoogleSearchResults({}).get_location(city, 1)[0]["canonical_name"]
- search = GoogleSearchResults({
+ location = GoogleSearch({}).get_location(city, 1)[0]["canonical_name"]
+ search = GoogleSearch({
  "q": "best coffee shop", # search search
  "location": location,
  "num": 1,
@@ -368,13 +368,13 @@ from queue import Queue
 import time
 
 # SerpApi search
-from serpapi import GoogleSearchResults
+from serpapi import GoogleSearch
 
 # store searches
 search_queue = Queue()
 
 # SerpApi search
-search = GoogleSearchResults({
+search = GoogleSearch({
  "location": "Austin,Texas",
  "async": True
 })
@@ -391,7 +391,7 @@ for company in ['amd','nvidia','intel']:
 print("wait until all search statuses are cached or success")
 
 # Create regular search
-search = GoogleSearchResults({"async": True})
+search = GoogleSearch({"async": True})
 while not search_queue.empty():
  search = search_queue.get()
  search_id = search['search_metadata']['id']
@@ -428,6 +428,9 @@ To keep thing simple, this example does only explore search result one at a time
 [See example.](https://github.com/serpapi/google-search-results-python/blob/master/tests/test_example.py)
 
 ## Change log
+2020-10-26 @ 2.0.0
+ - Reduce class name to <engine>Search
+ - Add get_raw_json
 2020-06-30 @ 1.8.3
  - simplify import
  - improve package for python 3.5+
@@ -438,7 +441,7 @@ To keep thing simple, this example does only explore search result one at a time
 2019-11-10 @ 1.7.1
  - increase engine parameter priority over engine value set in the class
 2019-09-12 @ 1.7
- - Change namespace "from lib." instead: "from serpapi import GoogleSearchResults"
+ - Change namespace "from lib." instead: "from serpapi import GoogleSearch"
  - Support for Bing and Baidu
 2019-06-25 @ 1.6
  - New search engine supported: Baidu and Bing

README.rst

@@ -32,8 +32,8 @@ Quick start
 
 .. code-block:: python
 
- from serpapi import GoogleSearchResults
- search = GoogleSearchResults({"q": "coffee", "location": "Austin,Texas", "api_key": "secretKey"})
+ from serpapi import GoogleSearch
+ search = GoogleSearch({"q": "coffee", "location": "Austin,Texas", "api_key": "secretKey"})
  result = search.get_dict()
 
 This example runs a search about "coffee" using your secret api key.
@@ -44,7 +44,7 @@ The Serp API service (backend)
 * parses the messy HTML responses
 * return a standardizes JSON response
 
-The GoogleSearchResults class
+The GoogleSearch class
 
 * Format the request
 * Execute GET http request against Serp API service
@@ -54,12 +54,12 @@ Et voila..
 
 Alternatively, you can search:
 
-- Bing using BingSearchResults class
-- Baidu using BaiduSearchResults class
-- Yahoo using YahooSearchResults class
-- Ebay using EbaySearchResults class
-- Yandex using YandexSearchResults class
-- GoogleScholar using GoogleScholarSearchResults class
+- Bing using BingSearch class
+- Baidu using BaiduSearch class
+- Yahoo using YahooSearch class
+- Ebay using EbaySearch class
+- Yandex using YandexSearch class
+- GoogleScholar using GoogleScholarSearch class
 
 See the `playground to generate your code. <https://serpapi.com/playground>`_
 

serpapi/__init__.py

@@ -1,8 +1,8 @@
 from .serp_api_client import SerpApiClient
-from .baidu_search_results import BaiduSearchResults
-from .google_search_results import GoogleSearchResults
-from .yahoo_search_results import YahooSearchResults
-from .bing_search_results import BingSearchResults
-from .yandex_search_results import YandexSearchResults
-from .google_scholar_search_results import GoogleScholarSearchResults
-from .ebay_search_results import EbaySearchResults
+from .baidu_search import BaiduSearch
+from .google_search import GoogleSearch
+from .yahoo_search import YahooSearch
+from .bing_search import BingSearch
+from .yandex_search import YandexSearch
+from .google_scholar_search import GoogleScholarSearch
+from .ebay_search import EbaySearch

serpapi/baidu_search_results.py renamed to serpapi/baidu_search.py

@@ -1,18 +1,18 @@
 from serpapi.serp_api_client import *
 
-class BaiduSearchResults(SerpApiClient):
- """BaiduSearchResults enables to search baidu and parse the result.
+class BaiduSearch(SerpApiClient):
+ """BaiduSearch enables to search baidu and parse the result.
  ```python
- from serpapi import BaiduSearchResults
- query = BaiduSearchResults({"q": "coffee"})
+ from serpapi import BaiduSearch
+ query = BaiduSearch({"q": "coffee"})
  data = query.get_json()
  ```
 
  doc: https://serpapi.com/baidu-search-api
  """
 
  def __init__(self, params_dict):
- super(BaiduSearchResults, self).__init__(params_dict, BAIDU_ENGINE)
+ super(BaiduSearch, self).__init__(params_dict, BAIDU_ENGINE)
 
  def get_location(self, q, limit = 5):
  raise "location is not supported by Baidu search engine at this time"

serpapi/bing_search.py

@@ -0,0 +1,15 @@
+from serpapi.serp_api_client import *
+
+class BingSearch(SerpApiClient):
+ """BingSearch enables to search bing and parse the result.
+ ```python
+ from serpapi import BingSearch
+ query = BingSearch({"q": "coffee", "location": "Austin,Texas"})
+ data = query.get_json()
+ ```
+
+ doc: https://serpapi.com/bing-search-api
+ """
+
+ def __init__(self, params_dict):
+ super(BingSearch, self).__init__(params_dict, BING_ENGINE)

serpapi/bing_search_results.py

@@ -1,18 +1,18 @@
 from serpapi.serp_api_client import *
 
-class EbaySearchResults(SerpApiClient):
- """EbaySearchResults enables to search ebay and parse the result.
+class EbaySearch(SerpApiClient):
+ """EbaySearch enables to search ebay and parse the result.
  ```python
- from serpapi import EbaySearchResults
- query = EbaySearchResults({"_nkw": "coffee"})
+ from serpapi import EbaySearch
+ query = EbaySearch({"_nkw": "coffee"})
  data = query.get_json()
  ```
 
  doc: https://serpapi.com/ebay-search-api
  """
 
  def __init__(self, params_dict):
- super(EbaySearchResults, self).__init__(params_dict, EBAY_ENGINE)
+ super(EbaySearch, self).__init__(params_dict, EBAY_ENGINE)
 
  def get_location(self, q, limit = 5):
  raise "location is not supported by Ebay search engine at this time"