finishing touches

Author: deeleeramone

…s/famafrench/openbb_famafrench/apps.json …rench/openbb_famafrench/assets/apps.jsonopenbb_platform/providers/famafrench/openbb_famafrench/apps.json renamed to openbb_platform/providers/famafrench/openbb_famafrench/assets/apps.json openbb_platform/providers/famafrench/openbb_famafrench/apps.json renamed to openbb_platform/providers/famafrench/openbb_famafrench/assets/apps.json

@@ -185,6 +185,9 @@ async def factor_choices(
             },
         ),
     ],
+    widget_config={
+        "name": "Fama-French US Portfolio Returns",
+    },
 )
 async def us_portfolio_returns(
     cc: CommandContext,
@@ -522,6 +525,6 @@ async def famafrench_apps():
     import json
     from pathlib import Path
 
-    _APPS_JSON = Path(__file__).parent / "apps.json"
+    _APPS_JSON = Path(__file__).parent / "assets" / "apps.json"
 
     return json.loads(_APPS_JSON.read_text(encoding="utf-8"))

openbb_platform/providers/famafrench/openbb_famafrench/famafrench_router.py

@@ -1,7 +1,5 @@
 """Fama-French Breakpoints Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any
 
@@ -256,7 +254,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract data from the Fama-French FTP."""
-        # pylint: disable=import-outside-toplevel
         from openbb_famafrench.utils.helpers import get_breakpoint_data
 
         try:

openbb_platform/providers/famafrench/openbb_famafrench/models/breakpoints.py

@@ -1,7 +1,5 @@
 """Fama-French Factors Fetcher Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any, Literal
 
@@ -209,7 +207,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract data from the Fama-French FTP."""
-        # pylint: disable=import-outside-toplevel
         from openbb_famafrench.utils.helpers import get_international_portfolio  # noqa
         from warnings import warn
 
@@ -229,7 +226,7 @@ async def aextract_data(
                     else query.all_data_items_required
                 ),
             )
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             raise OpenBBError(e) from e
 
     @staticmethod
@@ -239,7 +236,6 @@ def transform_data(
         **kwargs: Any,
     ) -> AnnotatedResult[list[FamaFrenchCountryPortfolioReturnsData]]:
         """Transform the extracted data."""
-        # pylint: disable=import-outside-toplevel
         from pandas import MultiIndex
 
         dfs, meta = data

openbb_platform/providers/famafrench/openbb_famafrench/models/country_portfolio_returns.py

@@ -1,7 +1,5 @@
 """Fama-French Factors Fetcher Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any, Literal
 
@@ -269,7 +267,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract the data from the FTP."""
-        # pylint: disable=import-outside-toplevel, broad-except
         from openbb_famafrench.utils.helpers import get_portfolio_data
 
         factors = FACTOR_REGION_MAP.get(query.region, {})
@@ -296,7 +293,6 @@ def transform_data(
         **kwargs: Any,
     ) -> AnnotatedResult[list[FamaFrenchFactorsData]]:
         """Transform the raw data and insert metadata."""
-        # pylint: disable=import-outside-toplevel
         from pandas import to_datetime
 
         table = data[0][0].reset_index()

openbb_platform/providers/famafrench/openbb_famafrench/models/factors.py

@@ -1,7 +1,5 @@
 """Fama-French Factors Fetcher Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any, Literal
 
@@ -212,7 +210,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract data from the Fama-French FTP."""
-        # pylint: disable=import-outside-toplevel
         from openbb_famafrench.utils.helpers import get_international_portfolio  # noqa
         from warnings import warn
 
@@ -232,7 +229,7 @@ async def aextract_data(
                     else query.all_data_items_required
                 ),
             )
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             raise OpenBBError(e) from e
 
     @staticmethod
@@ -242,7 +239,6 @@ def transform_data(
         **kwargs: Any,
     ) -> AnnotatedResult[list[FamaFrenchInternationalIndexReturnsData]]:
         """Transform the extracted data."""
-        # pylint: disable=import-outside-toplevel
         from pandas import MultiIndex
 
         dfs, meta = data

openbb_platform/providers/famafrench/openbb_famafrench/models/international_index_returns.py

@@ -1,7 +1,5 @@
 """Fama-French Factors Fetcher Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any, Literal
 
@@ -107,7 +105,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract data from the Fama-French FTP."""
-        # pylint: disable=import-outside-toplevel
         from openbb_famafrench.utils.helpers import get_portfolio_data
 
         dataset = ""
@@ -123,7 +120,7 @@ async def aextract_data(
                 measure=query.measure,
                 frequency=(None if "daily" in dataset.lower() else query.frequency),
             )
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             raise OpenBBError(e) from e
 
     @staticmethod

openbb_platform/providers/famafrench/openbb_famafrench/models/regional_portfolio_returns.py

@@ -1,7 +1,5 @@
 """Fama-French Factors Fetcher Model."""
 
-# pylint: disable=unused-argument
-
 from datetime import date as dateType
 from typing import Any, Literal
 
@@ -106,7 +104,6 @@ async def aextract_data(
         **kwargs: Any,
     ) -> tuple:
         """Extract data from the Fama-French FTP."""
-        # pylint: disable=import-outside-toplevel
         from openbb_famafrench.utils.helpers import get_portfolio_data
 
         dataset = ""
@@ -126,7 +123,7 @@ async def aextract_data(
                     else query.frequency
                 ),
             )
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             raise OpenBBError(e) from e
 
     @staticmethod

openbb_platform/providers/famafrench/openbb_famafrench/models/us_portfolio_returns.py

@@ -1,7 +1,5 @@
 """Constants for the Fama French datasets API."""
 
-# pylint: disable=too-many-lines
-
 from typing import Any, Literal
 
 BASE_URL = "https://mba.tuck.dartmouth.edu/pages/faculty/ken.french/ftp/"

openbb_platform/providers/famafrench/openbb_famafrench/utils/constants.py

@@ -1,7 +1,5 @@
 """Fama-French utilities for handling US and International portfolios and factors."""
 
-# pylint: disable=R0912,R0913,R0914,R0917,R1702,W0612,W0613
-
 from functools import lru_cache
 
 from openbb_famafrench.utils.constants import (
@@ -152,7 +150,6 @@ def download_file(dataset) -> str:
 
     Note: This function is not intended for direct use, it is called by `get_portfolio_data`.
     """
-    # pylint: disable=import-outside-toplevel
     import zipfile
     from io import BytesIO
 
@@ -200,7 +197,6 @@ def download_international_portfolios(url):
     Note: This function is not intended for direct use,
     it is called by `get_international_portfolio`.
     """
-    # pylint: disable=import-outside-toplevel
     from openbb_core.provider.utils.helpers import get_requests_session
 
     with get_requests_session() as session:
@@ -212,7 +208,6 @@ def download_international_portfolios(url):
 
 def apply_date(x):
     """Pandas Apply helper to convert various date formats to a standard YYYY-MM-DD format."""
-    # pylint: disable=import-outside-toplevel
     from pandas import to_datetime
 
     date = str(x).replace(" ", "")
@@ -232,7 +227,6 @@ def read_csv_file(data: str):
 
     Note: This function is not intended for direct use, it is called by `get_portfolio_data`.
     """
-    # pylint: disable=import-outside-toplevel
     import re
 
     lines = data.splitlines()
@@ -333,7 +327,6 @@ def process_csv_tables(tables, general_description="") -> tuple:
 
     Note: This function is not intended for direct use, it is called by `get_portfolio_data`.
     """
-    # pylint: disable=import-outside-toplevel
     import warnings  # noqa
     from pandas import DataFrame
 
@@ -367,7 +360,7 @@ def process_csv_tables(tables, general_description="") -> tuple:
         try:
             # Convert YYYYMM format to datetime
             df["Date"] = df.Date.apply(apply_date)
-        except Exception as e:  # pylint: disable=W0718
+        except Exception as e:
             warnings.warn(f"Error parsing dates: {e}")
             df["Date"] = df["Date"].astype(str)
 
@@ -403,7 +396,6 @@ def read_dat_file(data: str) -> list:
     Note: This function is not intended for direct use,
     it is called by `get_international_portfolio`.
     """
-    # pylint: disable=import-outside-toplevel
     import re
 
     lines = data.splitlines()
@@ -524,7 +516,6 @@ def get_international_portfolio_data(
 
     Note: Not intended for direct use, this function is called by `get_international_portfolio`.
     """
-    # pylint: disable=import-outside-toplevel
     import zipfile
     from io import BytesIO
 
@@ -584,7 +575,6 @@ def process_international_portfolio_data(tables: list, dividends: bool = True) -
 
     Note: Not intended for direct use, this function is called by `get_international_portfolio`.
     """
-    # pylint: disable=import-outside-toplevel
     import re  # noqa
     import warnings
     from pandas import DataFrame, MultiIndex
@@ -614,7 +604,7 @@ def process_international_portfolio_data(tables: list, dividends: bool = True) -
         # Parse and set Date column
         try:
             df["Date"] = df["Date"].apply(apply_date)
-        except Exception as e:  # pylint: disable=W0718
+        except Exception as e:
             warnings.warn(f"Error parsing dates. Using string conversion. -> {e}")
             df["Date"] = df["Date"].astype(str)
 
@@ -898,7 +888,6 @@ def get_breakpoint_data(
     tuple
         A tuple containing a pandas DataFrames a metadata dictionary.
     """
-    # pylint: disable=import-outside-toplevel
     from io import StringIO  # noqa
     from pandas import offsets, read_csv, to_datetime