feat(connector): add functionality that lists supported websites

dataprep/connector/__init__.py

@@ -4,14 +4,15 @@
 
 from .connector import Connector
 from .generator import ConfigGenerator, ConfigGeneratorUI
-from .info import info
+from .info import info, websites
 
 __all__ = [
     "Connector",
     "ConfigGenerator",
     "ConfigGeneratorUI",
     "connect",
     "info",
+    "websites",
 ]
 
 

dataprep/connector/info.py

@@ -2,8 +2,9 @@
 from typing import Any, Dict, List
 
 import pandas as pd
+from IPython.display import display
 
-from ..utils import get_styled_schema
+from ..utils import get_styled_schema, is_notebook
 from .implicit_database import ImplicitDatabase
 from .info_ui import info_ui
 from .schema import ConfigDef
@@ -111,3 +112,35 @@ def get_schema(schema: Dict[str, Any]) -> pd.DataFrame:
         new_schema_dict["data_type"].append(schema[k].type)
 
     return pd.DataFrame.from_dict(new_schema_dict)
+
+
+def websites() -> None:
+    """Displays names of websites supported by data connector."""
+    websites = {
+        "business": ["yelp"],
+        "finance": ["finnhub"],
+        "geocoding": ["mapquest"],
+        "lifestyle": ["spoonacular"],
+        "music": ["musixmatch", "spotify"],
+        "news": ["guardian", "times"],
+        "science": ["dblp"],
+        "shopping": ["etsy"],
+        "social": ["twitch", "twitter"],
+        "video": ["youtube"],
+        "weather": ["openweathermap"],
+    }
+
+    supported_websites = pd.DataFrame.from_dict(websites, orient="index")
+    supported_websites = supported_websites.transpose()
+    supported_websites.columns = supported_websites.columns.str.upper()
+
+    # replace "None" values with empty string
+    mask = supported_websites.applymap(lambda x: x is None)
+    cols = supported_websites.columns[(mask).any()]
+    for col in supported_websites[cols]:
+        supported_websites.loc[mask[col], col] = ""
+
+    if is_notebook():
+        display(supported_websites)
+    else:
+        print(supported_websites.to_string(index=False))

dataprep/tests/connector/test_integration.py

@@ -3,7 +3,7 @@
 import asyncio
 import pytest
 
-from ...connector import Connector
+from ...connector import Connector, websites
 from ...utils import display_dataframe
 from ...connector.utils import Request
 
@@ -19,6 +19,8 @@ def test_connector() -> None:
 
     assert len(df) > 0
 
+    websites()
+
     dc.info()
 
     display_dataframe(df)