Rename sdk to SDK (#2968)

* Rename sdk to SDK

* Added README

* Fixed test

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
         args:
           [
             "--ignore-files=settings_controller.py,featflags_controller.py,keys_controller.py,degiro_controller.py,",
-            "--ignore-commands=login,alswe,info_swe,goodness,resources,yf,yolo,from,to,featflags,guess,settings,survey",
+            "--ignore-commands=login,alswe,info_swe,goodness,resources,yf,yolo,from,to,featflags,guess,settings,survey,intro",
           ]
         entry: python custom_pre_commit/check_doc.py
   - repo: https://github.com/pre-commit/pre-commit-hooks

docs/README.md

@@ -1,5 +1,16 @@
 # OpenBB Terminal Code Documentation
 
+## Creating Hugo SDK Documentation
+
+To generate markdown files for the Hugo website do the following:
+
+1. Go to the openbb directory:`cd ~/OpenBBTerminal`
+1. Generate the documentation: `python docs/generate.py`
+1. Change into the website directory: `cd website`
+1. Run the hugo server to confirm changes applied: `hugo server -D`
+
+## Creating Sphinx Documentation
+
 Requirements:
 
 - sphinx

docs/generate.py

@@ -165,11 +165,11 @@ def generate_dict(paths: List):
     final_dict: Dict[str, Any] = {}
     added_paths = []
     for path, subs in paths:
-        if not final_dict and path == "sdk":
-            final_dict = {"name": "sdk", "ref": "/sdk", "sub": []}
+        if not final_dict and path == "SDK":
+            final_dict = {"name": "SDK", "ref": "/SDK", "sub": []}
             for sub in subs:
                 final_dict["sub"].append({"name": sub, "ref": f"/{path}/{sub}"})
-            added_paths.append("sdk")
+            added_paths.append("SDK")
         if path not in added_paths:
             final_dict = set_items(final_dict, path, subs)
             added_paths.append(path)
@@ -189,9 +189,9 @@ def folder_documentation(path: str):
 
 
 if __name__ == "__main__":
-    base_folder_path = os.path.realpath("./website/content/sdk")
+    base_folder_path = os.path.realpath("./website/content/SDK")
     target_path = os.path.realpath("./website/data/menu/main.yml")
-    main_path = os.path.realpath("./website/content/sdk")
+    main_path = os.path.realpath("./website/content/SDK")
     folder_list = crawl_folders(main_path)
     for folder_path in [x[0] for x in folder_list]:
         folder_documentation(folder_path)

tests/openbb_terminal/portfolio/csv/test_portfolio_model/test_tracking_error.csv

@@ -4,9 +4,7 @@ qtd,-
 ytd,"Adj Close   NaN
 Total       NaN
 dtype: float64"
-3m,"Adj Close   NaN
-Total       NaN
-dtype: float64"
+3m,-
 6m,"Adj Close   NaN
 Total       NaN
 dtype: float64"

website/content/SDK/crypto/dd/active/_index.md

@@ -1,7 +1,7 @@
 To obtain charts, make sure to add `chart=True` as the last parameter
 
 ## Get underlying data 
-### crypto.dd.active(symbol: str, interval: str = '24h', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame
+### crypto.dd.active(symbol: str, interval: str = '24h', start_date: int = 1262300400, end_date: int = 1666333817) -> pandas.core.frame.DataFrame
 
 Returns active addresses of a certain symbol
     [Source: https://glassnode.com]

website/content/SDK/crypto/dd/btcrb/_index.md

@@ -1,7 +1,7 @@
 To obtain charts, make sure to add `chart=True` as the last parameter
 
 ## Get underlying data 
-### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-18')
+### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-21')
 
 Get bitcoin price data
     [Price data from source: https://glassnode.com]
@@ -15,7 +15,7 @@ Get bitcoin price data
         Final date, format YYYY-MM-DD
 
 ## Getting charts 
-### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-18', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True)
+### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-21', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True)
 
 Displays bitcoin rainbow chart
     [Price data from source: https://glassnode.com]

website/content/SDK/crypto/dd/change/_index.md

@@ -1,7 +1,7 @@
 To obtain charts, make sure to add `chart=True` as the last parameter
 
 ## Get underlying data 
-### crypto.dd.change(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame
+### crypto.dd.change(symbol: str, exchange: str = 'binance', start_date: int = 1262300400, end_date: int = 1666333817) -> pandas.core.frame.DataFrame
 
 Returns 30d change of the supply held in exchange wallets of a certain symbol.
     [Source: https://glassnode.com]

website/content/SDK/crypto/dd/close/_index.md

@@ -1,5 +1,5 @@
 ## Get underlying data 
-### crypto.dd.close(symbol: str, start_date: str = '2010-01-01', end_date: str = '2022-10-18', print_errors: bool = True) -> pandas.core.frame.DataFrame
+### crypto.dd.close(symbol: str, start_date: str = '2010-01-01', end_date: str = '2022-10-21', print_errors: bool = True) -> pandas.core.frame.DataFrame
 
 Returns the price of a cryptocurrency
     [Source: https://glassnode.com]

website/content/SDK/crypto/dd/eb/_index.md

@@ -1,7 +1,7 @@
 To obtain charts, make sure to add `chart=True` as the last parameter
 
 ## Get underlying data 
-### crypto.dd.eb(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame
+### crypto.dd.eb(symbol: str, exchange: str = 'binance', start_date: int = 1262300400, end_date: int = 1666333817) -> pandas.core.frame.DataFrame
 
 Returns the total amount of coins held on exchange addresses in units and percentage.
     [Source: https://glassnode.com]

website/content/SDK/crypto/dd/gh/_index.md

@@ -1,7 +1,7 @@
 To obtain charts, make sure to add `chart=True` as the last parameter
 
 ## Get underlying data 
-### crypto.dd.gh(symbol: str, dev_activity: bool = False, interval: str = '1d', start_date: str = '2021-10-18T13:03:27Z', end_date: str = '2022-10-18T13:03:27Z') -> pandas.core.frame.DataFrame
+### crypto.dd.gh(symbol: str, dev_activity: bool = False, interval: str = '1d', start_date: str = '2021-10-21T08:30:17Z', end_date: str = '2022-10-21T08:30:17Z') -> pandas.core.frame.DataFrame
 
 Returns  a list of developer activity for a given coin and time interval.
 
@@ -26,7 +26,7 @@ Returns  a list of developer activity for a given coin and time interval.
         developer activity over time
 
 ## Getting charts 
-### crypto.dd.gh(symbol: str, start_date: str = '2021-10-18T13:03:27Z', dev_activity: bool = False, end_date: str = '2022-10-18T13:03:27Z', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None
+### crypto.dd.gh(symbol: str, start_date: str = '2021-10-21T08:30:17Z', dev_activity: bool = False, end_date: str = '2022-10-21T08:30:17Z', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None
 
 Returns a list of github activity for a given coin and time interval.