documentation tweak and syntax clean-up

Author: jvmvik

serpapi/google_scholar_search_results.py

@@ -8,7 +8,7 @@ class GoogleScholarSearchResults(SerpApiClient):
  data = query.get_json()
  ```
 
- doc: https://serpapi.com/baidu-search-api
+ doc: https://serpapi.com/google-scholar-api
  """
 
  def __init__(self, params_dict):

serpapi/serp_api_client.py

@@ -10,14 +10,19 @@
 YAHOO_ENGINE = 'yahoo'
 
 class SerpApiClient(object):
- """GoogleSearchResults enables to search google and parse the result.
+ """SerpApiClient enables to search any engine support by SerpApi and parse the result.
  ```python
  from serpapi.google_search_results import GoogleSearchResults
- query = SerpApiClient({"q": "coffee", "location": "Austin,Texas"}, "google")
- data = query.get_json()
+ client = SerpApiClient({
+ "q": "Coffee", 
+ "location": "Austin,Texas", 
+ "engine": "google",
+ "api_key": "<your private key>"
+ })
+data = client.get_json()
  ```
 
- https://github.com/serpapi/google-search-results-python
+ https://serpapi.com/search-api
  """
 
  BACKEND = "https://serpapi.com"
@@ -58,7 +63,7 @@ def get_html(self):
 
  def get_json(self):
  """Returns:
- Formatted JSON search result
+ Formatted search result as JSON
  """
  self.params_dict["output"] = "json"
  return json.loads(self.get_results())
@@ -72,6 +77,7 @@ def get_dictionary(self):
  def get_dict(self):
  """Returns:
  Dict with the formatted response content
+ (alias for get_dictionary)
  """
  return self.get_dictionary()
 

tests/test_google_search_results.py

@@ -0,0 +1,48 @@
+import random
+import unittest
+import os
+import pprint
+from serpapi.google_search_results import GoogleSearchResults
+
+class TestSearchApi(unittest.TestCase):
+
+def setUp(self):
+GoogleSearchResults.SERP_API_KEY = os.getenv("API_KEY", "demo")
+
+@unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
+def test_get_json(self):
+client = GoogleSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+data = client.get_json()
+self.assertEqual(data["search_metadata"]["status"], "Success")
+self.assertIsNotNone(data["search_metadata"]["google_url"])
+self.assertIsNotNone(data["search_metadata"]["id"])
+# pp = pprint.PrettyPrinter(indent=2)
+# pp.pprint(data['local_results'])
+self.assertIsNotNone(data['local_results']['places'][0])
+
+@unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
+def test_get_json(self):
+client = GoogleSearchResults({"q": "Coffee", "engine": "google_scholar"})
+data = client.get_json()
+self.assertIsNotNone(data["organic_results"][0]["title"])
+
+@unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
+def test_get_dict(self):
+client = GoogleSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+data = client.get_dict()
+self.assertIsNotNone(data.get('local_results'))
+
+@unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
+def test_get_dictionary(self):
+client = GoogleSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+data = client.get_dictionary()
+self.assertIsNotNone(data.get('local_results'))
+
+@unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
+def test_get_html(self):
+client = GoogleSearchResults({"q": "Coffee", "location": "Austin,Texas"})
+data = client.get_html()
+self.assertGreater(len(data), 10)
+
+if __name__ == '__main__':
+unittest.main()

tests/test_serp_api_client.py

@@ -9,12 +9,14 @@
 # 
 class TestSerpSearchApi(unittest.TestCase):
 
-def setUp(self):
-SerpApiClient.SERP_API_KEY = os.getenv("API_KEY", "demo")
-
 @unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
 def test_get_json(self):
-client = SerpApiClient({"q": "Coffee", "location": "Austin,Texas", "engine": "google_scholar"})
+client = SerpApiClient({
+"q": "Coffee", 
+"location": "Austin,Texas", 
+"engine": "google_scholar",
+"api_key": os.getenv("API_KEY", "demo")
+})
 data = client.get_json()
 self.assertIsNotNone(data["organic_results"][0]["title"])
 pp = pprint.PrettyPrinter(indent=2)