query google_maps_directions (#29)

* query google_maps_directions

* refactoring

* added example

* renamed

Author: kseniia-maiesh

examples/Google Directions.md

@@ -0,0 +1,30 @@
+# Google Directions With Python
+
+Returns directions between two points from Google Maps. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Google/paths/~1maps~1directions/get).
+
+## Installation
+
+Python 3+
+```bash
+pip install outscraper
+```
+
+[Link to the Python package page](https://pypi.org/project/outscraper/)
+
+## Initialization
+```python
+from outscraper import ApiClient
+
+client = ApiClient(api_key='SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+## Usage
+
+```python
+# Returns directions:
+results = client.google_maps_directions([
+    ['29.696596, 76.994928', '30.715966244353, 76.8053887016268'],
+    ['29.696596, 76.994928', '30.723065, 76.770169']
+])
+```

outscraper/api_client.py

@@ -2,7 +2,7 @@
 from time import sleep
 from typing import Union, Tuple
 
-from .utils import as_list, parse_fields
+from .utils import as_list, parse_fields, format_direction_queries
 
 
 class ApiClient(object):
@@ -323,7 +323,8 @@ def google_maps_directions(self, query: Union[list, str], departure_time: int =
 
             See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1directions/get
         '''
-        queries = as_list(query)
+
+        queries = format_direction_queries(query)
         wait_async = async_request or len(queries) > 10
 
         response = requests.get(f'{self._api_url}/maps/directions', params={

outscraper/utils.py

@@ -1,5 +1,6 @@
 from typing import Union
 
+QUERY_DELIMITER = '    '
 
 def as_list(value: Union[list, str]) -> list:
     if isinstance(value, list):
@@ -13,3 +14,11 @@ def parse_fields(fields: Union[list, str]) -> str:
         return ','.join(fields)
     else:
         return fields
+
+
+def format_direction_queries(q: Union[list, str]) -> list[str]:
+    if isinstance(q, list):
+        if all(isinstance(i, list) for i in q):
+            return [QUERY_DELIMITER.join(pair) for pair in q]
+        return q
+    return [q]