Adds command to check top hackernews stories

openbb_terminal/alternative/alt_controller.py

@@ -1,16 +1,21 @@
 """Alternative Data Controller Module"""
 __docformat__ = "numpy"
 
+import argparse
 import logging
 from typing import List
 
 from openbb_terminal.custom_prompt_toolkit import NestedCompleter
 
 from openbb_terminal import feature_flags as obbff
 from openbb_terminal.decorators import log_start_end
+from openbb_terminal.helper_funcs import (
+    EXPORT_ONLY_RAW_DATA_ALLOWED,
+)
 from openbb_terminal.menu import session
 from openbb_terminal.parent_classes import BaseController
 from openbb_terminal.rich_config import console, MenuText
+from openbb_terminal.alternative import hackernews_view
 
 logger = logging.getLogger(__name__)
 # pylint:disable=import-outside-toplevel
@@ -19,7 +24,7 @@
 class AlternativeDataController(BaseController):
     """Alternative Controller class"""
 
-    CHOICES_COMMANDS: List[str] = []
+    CHOICES_COMMANDS: List[str] = ["hn"]
     CHOICES_MENUS = ["covid", "oss"]
     PATH = "/alternative/"
     CHOICES_GENERATION = True
@@ -38,6 +43,8 @@ def print_help(self):
         mt = MenuText("alternative/")
         mt.add_menu("covid")
         mt.add_menu("oss")
+        mt.add_raw("\n")
+        mt.add_cmd("hn")
         console.print(text=mt.menu_text, menu="Alternative")
 
     @log_start_end(log=logger)
@@ -53,3 +60,24 @@ def call_oss(self, _):
         from openbb_terminal.alternative.oss.oss_controller import OSSController
 
         self.queue = self.load_class(OSSController, self.queue)
+
+    @log_start_end(log=logger)
+    def call_hn(self, other_args: List[str]):
+        """Process hn command"""
+
+        parser = argparse.ArgumentParser(
+            add_help=False,
+            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+            prog="hn",
+            description="Display Hacker News",
+        )
+
+        ns_parser = self.parse_known_args_and_warn(
+            parser,
+            other_args,
+            export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED,
+            limit=10,
+        )
+
+        if ns_parser:
+            hackernews_view.display_stories(limit=ns_parser.limit)

openbb_terminal/alternative/hackernews_model.py

@@ -0,0 +1,38 @@
+"""HackerNews Model"""
+__docformat__ = "numpy"
+
+
+import logging
+import pandas as pd
+import requests
+
+
+logger = logging.getLogger(__name__)
+
+
+def get_stories(limit: int = 10) -> pd.DataFrame:
+    """Get top stories from HackerNews.
+    Parameters
+    ----------
+    limit: int
+        Number of stories to return
+    Returns
+    -------
+    pd.DataFrame
+        DataFrame with stories
+    """
+
+    res = requests.get("https://hacker-news.firebaseio.com/v0/topstories.json")
+    if res.status_code == 200:
+        top_stories = res.json()
+        stories = []
+        for story_id in top_stories[:limit]:
+            story = requests.get(
+                f"https://hacker-news.firebaseio.com/v0/item/{story_id}.json"
+            ).json()
+            stories.append(story)
+        df = pd.DataFrame(stories)
+        df["time"] = pd.to_datetime(df["time"], unit="s")
+        df = df[["title", "url", "score", "type", "time"]]
+        return df
+    return pd.DataFrame()

openbb_terminal/alternative/hackernews_view.py

@@ -0,0 +1,31 @@
+"""HackerNews view"""
+__docformat__ = "numpy"
+
+import logging
+import os
+
+from openbb_terminal.alternative.hackernews_model import get_stories
+from openbb_terminal.decorators import log_start_end
+from openbb_terminal.helper_funcs import (
+    export_data,
+    print_rich_table,
+)
+
+logger = logging.getLogger(__name__)
+
+
+@log_start_end(log=logger)
+def display_stories(limit: int = 10, export: str = "") -> None:
+    """View top stories from HackerNews.
+    Parameters
+    ----------
+    limit: int
+        Number of stories to return
+    export: str
+        Export dataframe data to csv,json,xlsx file
+    """
+    df = get_stories(limit)
+    if not df.empty:
+        df.columns = [col.capitalize() for col in df.columns]
+        print_rich_table(df, title="HackerNews Top Stories")
+    export_data(export, os.path.dirname(os.path.abspath(__file__)), "hn", df)

openbb_terminal/miscellaneous/data_sources_default.json

@@ -508,6 +508,7 @@
       "rs": ["GitHub"],
       "sh": ["GitHub"],
       "tr": ["GitHub"]
-    }
+    },
+    "hn": ["HackerNews"]
   }
 }

openbb_terminal/miscellaneous/i18n/en.yml

@@ -858,6 +858,7 @@ en:
   funds/alswe: display fund allocation (sector, country, holdings)
   funds/infoswe: get fund information
   funds/forecast: forecasting techniques
+  alternative/hn: Hacker News most popular stories
   alternative/covid: COVID menu,                 cases, deaths, rates
   alternative/oss: Open Source menu,           star history, repos information
   alternative/covid/slopes: get countries with highest slope in cases

openbb_terminal/miscellaneous/library/trail_map.csv

@@ -1,4 +1,5 @@
 trail,model,view
+alt.hn,openbb_terminal.alternative.hackernews_model.get_stories,openbb_terminal.alternative.hackernews_view.display_stories
 alt.covid.slopes,openbb_terminal.alternative.covid.covid_model.get_case_slopes,openbb_terminal.alternative.covid.covid_view.display_case_slopes
 alt.covid.global_cases,openbb_terminal.alternative.covid.covid_model.get_global_cases,
 alt.covid.global_deaths,openbb_terminal.alternative.covid.covid_model.get_global_deaths,