openbb-charting 2.0.3__tar.gz → 2.1.1__tar.gz

{openbb_charting-2.0.3 → openbb_charting-2.1.1}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: openbb-charting
-Version: 2.0.3
+Version: 2.1.1
 Summary: Charting extension for OpenBB
+License: AGPL-3.0-only
 Author: OpenBB Team
 Author-email: hello@openbb.co
 Requires-Python: >=3.8,<3.12
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: nbformat (>=5.9.2,<6.0.0)
-Requires-Dist: openbb-core (>=1.1.6,<2.0.0)
+Requires-Dist: openbb-core (>=1.2.3,<2.0.0)
 Requires-Dist: pandas-ta (>=0.3.14b,<0.4.0)
 Requires-Dist: plotly (>=5.17.0,<6.0.0)
 Requires-Dist: pywry (>=0.6.1,<0.7.0)
-Requires-Dist: reportlab (>=4.0.4,<5.0.0)
 Requires-Dist: scipy (>=1.10.0,<2.0.0)
 Requires-Dist: statsmodels (>=0.14.0,<0.15.0)
-Requires-Dist: svglib (>=1.5.1,<2.0.0)
 Description-Content-Type: text/markdown
 
 # OpenBB Charting extension

{openbb_charting-2.0.3 → openbb_charting-2.1.1}/openbb_charting/__init__.py

@@ -35,13 +35,12 @@ warnings.filterwarnings(
     "ignore", category=UserWarning, module="openbb_core.app.model.extension", lineno=47
 )
 
-ext = Extension(name="charting")
+ext = Extension(name="charting", description="Create custom charts from OBBject data.")
 
 
 @ext.obbject_accessor
 class Charting:
-    """
-    Charting extension.
+    """Charting extension.
 
     Methods
     -------
@@ -61,6 +60,8 @@ class Charting:
         Create a line chart from external data.
     create_bar_chart
         Create a bar chart, on a single x-axis with one or more values for the y-axis, from external data.
+    toggle_chart_style
+        Toggle the chart style, of an existing chart, between light and dark mode.
     """
 
     def __init__(self, obbject):
@@ -77,8 +78,8 @@ class Charting:
 
     @classmethod
     def indicators(cls):
-        """
-        Return an instance of the IndicatorsParams class, containing all available indicators and their parameters.
+        """Return an instance of the IndicatorsParams class, containing all available indicators and their parameters.
+
         Without assigning to a variable, it will print the the information to the console.
         """
         return IndicatorsParams()
@@ -90,7 +91,6 @@ class Charting:
 
     def _handle_backend(self) -> Backend:
         """Create and start the backend."""
-
         create_backend(self._charting_settings)
         backend = get_backend()
         backend.start(debug=self._charting_settings.debug_mode)
@@ -99,15 +99,14 @@ class Charting:
     @staticmethod
     def _get_chart_function(route: str) -> Callable:
         """Given a route, it returns the chart function. The module must contain the given route."""
-
         if route is None:
             raise ValueError("OBBject was initialized with no function route.")
         adjusted_route = route.replace("/", "_")[1:]
         return getattr(charting_router, adjusted_route)
 
     def get_params(self) -> ChartParams:
-        """
-        Return the ChartQueryParams class for the function the OBBject was created from.
+        """Return the ChartQueryParams class for the function the OBBject was created from.
+
         Without assigning to a variable, it will print the docstring to the console.
         """
         if self._obbject._route is None:  # pylint: disable=protected-access
@@ -126,7 +125,7 @@ class Charting:
     ) -> Tuple[pd.DataFrame, bool]:
         """Convert supplied data to a DataFrame."""
         has_data = (
-            isinstance(data, (Data, pd.DataFrame, pd.Series)) and not data.empty
+            isinstance(data, (Data, pd.DataFrame, pd.Series)) and not data.empty  # type: ignore
         ) or (bool(data))
         index = (
             data.index.name
@@ -234,6 +233,7 @@ class Charting:
             same_axis=same_axis,
             **kwargs,
         )
+        fig = self._set_chart_style(fig)
         if render:
             return fig.show(**kwargs)
 
@@ -298,7 +298,6 @@ class Charting:
         OpenBBFigure
             The OpenBBFigure object.
         """
-
         fig = bar_chart(
             data=data,
             x=x,
@@ -313,7 +312,7 @@ class Charting:
             bar_kwargs=bar_kwargs,
             layout_kwargs=layout_kwargs,
         )
-
+        fig = self._set_chart_style(fig)
         if render:
             return fig.show(**kwargs)
 
@@ -322,7 +321,6 @@ class Charting:
     # pylint: disable=inconsistent-return-statements
     def show(self, render: bool = True, **kwargs):
         """Display chart and save it to the OBBject."""
-
         try:
             charting_function = self._get_chart_function(
                 self._obbject._route  # pylint: disable=protected-access
@@ -345,14 +343,17 @@ class Charting:
                 _kwargs = kwargs.pop("kwargs")
                 kwargs.update(_kwargs.get("chart_params", {}))
             fig, content = charting_function(**kwargs)
+            fig = self._set_chart_style(fig)
+            content = fig.show(external=True, **kwargs).to_plotly_json()
             self._obbject.chart = Chart(
                 fig=fig, content=content, format=charting_router.CHART_FORMAT
             )
             if render:
                 fig.show(**kwargs)
-        except Exception:
+        except Exception:  # pylint: disable=W0718
             try:
                 fig = self.create_line_chart(data=self._obbject.results, render=False, **kwargs)  # type: ignore
+                fig = self._set_chart_style(fig)
                 content = fig.show(external=True, **kwargs).to_plotly_json()  # type: ignore
                 self._obbject.chart = Chart(
                     fig=fig, content=content, format=charting_router.CHART_FORMAT
@@ -389,11 +390,10 @@ class Charting:
         render: bool = True,
         **kwargs,
     ):
-        """
-        Create an OpenBBFigure with user customizations (if any) and save it to the OBBject.
+        """Create an OpenBBFigure with user customizations (if any) and save it to the OBBject.
+
         This function is used to populate, or re-populate, the OBBject with a chart using the data within
         the OBBject or external data supplied via the `data` parameter.
-
         This function modifies the original OBBject by overwriting the existing chart.
 
         Parameters
@@ -459,6 +459,9 @@ class Charting:
             )
         kwargs["provider"] = self._obbject.provider  # pylint: disable=protected-access
         kwargs["extra"] = self._obbject.extra  # pylint: disable=protected-access
+        kwargs["extra_params"] = kwargs["extra"]["metadata"].arguments.get(
+            "extra_params"
+        )
         if "kwargs" in kwargs:
             _kwargs = kwargs.pop("kwargs")
             kwargs.update(_kwargs.get("chart_params", {}))
@@ -467,27 +470,55 @@ class Charting:
                 self.show(data=data_as_df, render=render, **kwargs)
             else:
                 self.show(**kwargs, render=render)
-        except Exception:
+        except Exception:  # pylint: disable=W0718
             try:
                 fig = self.create_line_chart(data=data_as_df, render=False, **kwargs)
+                fig = self._set_chart_style(fig)
                 content = fig.show(external=True, **kwargs).to_plotly_json()  # type: ignore
                 self._obbject.chart = Chart(
                     fig=fig, content=content, format=charting_router.CHART_FORMAT
                 )
                 if render:
                     return fig.show(**kwargs)  # type: ignore
-            except Exception as e:
+            except Exception as e:  # pylint: disable=W0718
                 raise RuntimeError(
                     "Failed to automatically create a generic chart with the data provided."
                 ) from e
 
+    def _set_chart_style(self, figure: Figure):
+        """Set the user preference for light or dark mode."""
+        style = self._charting_settings.chart_style  # pylint: disable=protected-access
+        font_color = "black" if style == "light" else "white"
+        paper_bgcolor = "white" if style == "light" else "black"
+        figure = figure.update_layout(
+            dict(  # pylint: disable=R1735
+                font_color=font_color, paper_bgcolor=paper_bgcolor
+            )
+        )
+        return figure
+
+    def toggle_chart_style(self):  # pylint: disable=protected-access
+        """Toggle the chart style between light and dark mode."""
+        if not hasattr(self._obbject.chart, "fig"):
+            raise ValueError(
+                "Error: No chart has been created. Please create a chart first."
+            )
+        current = self._charting_settings.chart_style
+        new = "light" if current == "dark" else "dark"
+        self._charting_settings.chart_style = new
+        figure = self._obbject.chart.fig  # type: ignore[union-attr]
+        updated_figure = self._set_chart_style(figure)
+        self._obbject.chart.fig = updated_figure  # type: ignore[union-attr]
+        self._obbject.chart.content = updated_figure.show(  # type: ignore[union-attr]
+            external=True
+        ).to_plotly_json()
+
     def table(
         self,
         data: Optional[Union[pd.DataFrame, pd.Series]] = None,
         title: str = "",
     ):
-        """
-        Display an interactive table.
+        """Display an interactive table.
 
         Parameters
         ----------
@@ -510,7 +541,7 @@ class Charting:
                     or self._obbject._route,  # pylint: disable=protected-access
                     theme=self._charting_settings.table_style,
                 )
-            except Exception as e:
+            except Exception as e:  # pylint: disable=W0718
                 warn(f"Failed to show figure with backend. {e}")
 
         else:

{openbb_charting-2.0.3 → openbb_charting-2.1.1}/openbb_charting/charting_router.py

@@ -8,6 +8,7 @@ from warnings import warn
 import pandas as pd
 from openbb_core.app.model.charts.chart import ChartFormat
 from openbb_core.app.utils import basemodel_to_df
+from openbb_core.provider.abstract.data import Data
 from plotly.graph_objs import Figure
 
 from openbb_charting.core.chart_style import ChartStyle
@@ -19,6 +20,7 @@ from openbb_charting.utils import relative_rotation
 from openbb_charting.utils.generic_charts import bar_chart
 from openbb_charting.utils.helpers import (
     calculate_returns,
+    duration_sorter,
     heikin_ashi,
     should_share_axis,
     z_score_standardization,
@@ -31,7 +33,6 @@ def equity_price_performance(
     **kwargs,
 ) -> Tuple[Union[OpenBBFigure, Figure], Dict[str, Any]]:  # noqa: PLR0912
     """Equity Price Performance Chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     elif "data" in kwargs and isinstance(kwargs["data"], list):
@@ -83,7 +84,7 @@ def equity_price_performance(
         limit = kwargs.pop("limit", 10)
         chart_df = chart_df.head(limit)  # type: ignore
 
-    layout_kwargs: Dict[str, Any] = kwargs["layout_kwargs"] if "layout_kwargs" in kwargs else {}  # type: ignore
+    layout_kwargs: Dict[str, Any] = kwargs.get("layout_kwargs", {})
 
     title = (
         f"{kwargs.pop('title')}" if "title" in kwargs else "Equity Price Performance"
@@ -140,7 +141,6 @@ def etf_price_performance(
 
 def etf_holdings(**kwargs) -> Tuple[Union[OpenBBFigure, Figure], Dict[str, Any]]:
     """Equity Compare Groups Chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     elif "data" in kwargs and isinstance(kwargs["data"], list):
@@ -198,7 +198,6 @@ def equity_price_historical(  # noqa: PLR0912
     **kwargs,
 ) -> Tuple[OpenBBFigure, Dict[str, Any]]:
     """Equity Price Historical Chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     elif "data" in kwargs and isinstance(kwargs["data"], list):
@@ -406,7 +405,7 @@ def equity_price_historical(  # noqa: PLR0912
                 name=data[col].name,
                 mode="lines",
                 hovertemplate=hovertemplate,
-                line=dict(width=1, color=LARGE_CYCLER[i % len(LARGE_CYCLER)]),
+                line=dict(width=2, color=LARGE_CYCLER[i % len(LARGE_CYCLER)]),
                 yaxis=yaxis,
             )
 
@@ -512,7 +511,6 @@ def crypto_price_historical(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
 def _ta_ma(**kwargs):
     """Plot moving average helper."""
-
     index = (
         kwargs.get("index")
         if "index" in kwargs and kwargs.get("index") is not None
@@ -587,8 +585,6 @@ def _ta_ma(**kwargs):
         ma_df = ma_df.dropna()
         data = data.iloc[-len(ma_df) :]
 
-    color = 0
-
     if (
         "candles" in kwargs
         and kwargs.get("candles") is True
@@ -600,7 +596,7 @@ def _ta_ma(**kwargs):
     else:
         ma_df[f"{target}".title()] = data[target]
 
-    for col in ma_df.columns:
+    for i, col in enumerate(ma_df.columns):
         name = col.replace("_", " ")
         fig.add_scatter(
             x=ma_df.index,
@@ -608,10 +604,9 @@ def _ta_ma(**kwargs):
             name=name,
             mode="lines",
             hovertemplate=f"{name}: %{{y}}<extra></extra>",
-            line=dict(width=1, color=LARGE_CYCLER[color]),
+            line=dict(width=1, color=LARGE_CYCLER[i]),
             showlegend=True,
         )
-        color += 1
 
     fig.update_layout(
         title=dict(text=title, x=0.5, font=dict(size=16)),
@@ -685,7 +680,6 @@ def technical_zlma(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
 def technical_aroon(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
     """Technical Aroon Chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     else:
@@ -726,7 +720,6 @@ def technical_aroon(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
 def technical_macd(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
     """Plot moving average convergence divergence chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     else:
@@ -765,7 +758,6 @@ def technical_macd(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
 def technical_adx(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
     """Average directional movement index chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     else:
@@ -801,7 +793,6 @@ def technical_adx(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
 def technical_rsi(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
     """Relative strength index chart."""
-
     if "data" in kwargs and isinstance(kwargs["data"], pd.DataFrame):
         data = kwargs["data"]
     else:
@@ -875,7 +866,6 @@ def technical_cones(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
         "orange",
         "blue",
     ]
-    color = 0
 
     fig = OpenBBFigure()
 
@@ -883,7 +873,7 @@ def technical_cones(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
 
     text_color = "black" if ChartStyle().plt_style == "light" else "white"
 
-    for col in df_ta.columns:
+    for i, col in enumerate(df_ta.columns):
         fig.add_scatter(
             x=df_ta.index,
             y=df_ta[col],
@@ -891,11 +881,10 @@ def technical_cones(**kwargs) -> Tuple[OpenBBFigure, Dict[str, Any]]:
             mode="lines+markers",
             hovertemplate=f"{col}: %{{y}}<extra></extra>",
             marker=dict(
-                color=colors[color],
+                color=colors[i],
                 size=11,
             ),
         )
-        color += 1
 
     fig.set_title(title)
 
@@ -1064,7 +1053,7 @@ def economy_fred_series(  # noqa: PLR0912
             if normalize:
                 y1title = None
                 title = f"{title} - Normalized" if title else "Normalized"
-            bar_mode = kwargs["barmode"] if "barmode" in kwargs else "group"
+            bar_mode = kwargs.get("barmode", "group")
             fig = bar_chart(
                 df_ta.reset_index(),
                 "date",
@@ -1119,7 +1108,7 @@ def economy_fred_series(  # noqa: PLR0912
             name=df_ta[col].name,
             mode="lines",
             hovertemplate=f"{df_ta[col].name}: %{{y}}<extra></extra>",
-            line=dict(width=1, color=LARGE_CYCLER[i % len(LARGE_CYCLER)]),
+            line=dict(width=2, color=LARGE_CYCLER[i % len(LARGE_CYCLER)]),
             yaxis="y1" if kwargs.get("same_axis") is True else yaxes,
         )
 
@@ -1228,7 +1217,6 @@ def technical_relative_rotation(
     **kwargs: Any,
 ) -> Tuple["OpenBBFigure", Dict[str, Any]]:
     """Relative Rotation Chart."""
-
     ratios_df = basemodel_to_df(kwargs["obbject_item"].rs_ratios, index="date")  # type: ignore
     momentum_df = basemodel_to_df(kwargs["obbject_item"].rs_momentum, index="date")  # type: ignore
     benchmark_symbol = kwargs["obbject_item"].benchmark  # type: ignore
@@ -1253,7 +1241,7 @@ def technical_relative_rotation(
             ratios_df, momentum_df, benchmark_symbol, study, date  # type: ignore
         )
 
-    figure = OpenBBFigure(fig)
+    figure = OpenBBFigure(fig)  # pylint: disable=E0606
     font_color = "black" if ChartStyle().plt_style == "light" else "white"
     figure.update_layout(
         paper_bgcolor="rgba(0,0,0,0)",
@@ -1292,3 +1280,167 @@ def technical_relative_rotation(
     content = figure.to_plotly_json()
 
     return figure, content
+
+
+def fixedincome_government_yield_curve(  # noqa: PLR0912
+    **kwargs,
+) -> Tuple[OpenBBFigure, Dict[str, Any]]:
+    """Government Yield Curve Chart."""
+    data = kwargs.get("data", None)
+    df: pd.DataFrame = pd.DataFrame()
+    if data:
+        if isinstance(data, pd.DataFrame) and not data.empty:  # noqa: SIM108
+            df = data
+        elif isinstance(data, (list, Data)):
+            df = basemodel_to_df(data, index=None)  # type: ignore
+        else:
+            pass
+    else:
+        df = pd.DataFrame([d.model_dump() for d in kwargs["obbject_item"]])  # type: ignore
+
+    if df.empty:
+        raise ValueError("Error: No data to plot.")
+
+    if "maturity" not in df.columns:
+        raise ValueError("Error: Maturity column not found in the data.")
+
+    if "rate" not in df.columns:
+        raise ValueError("Error: Rate column not found in the data.")
+
+    if "date" not in df.columns:
+        raise ValueError("Error: Date column not found in the data.")
+
+    provider = kwargs.get("provider")
+    df["date"] = df["date"].astype(str)
+    maturities = duration_sorter(df["maturity"].unique().tolist())
+
+    # Use the supplied colors, if any.
+    colors = kwargs.get("colors", [])
+    if not colors:
+        colors = LARGE_CYCLER
+    color_count = 0
+
+    figure = OpenBBFigure().create_subplots(shared_xaxes=True)
+    figure.update_layout(ChartStyle().plotly_template.get("layout", {}))
+
+    def create_fig(figure, df, dates, color_count, country: Optional[str] = None):
+        """Create a scatter for each date in the data."""
+        for date in dates:
+            color = colors[color_count % len(colors)]
+            plot_df = df[df["date"] == date].copy()
+            plot_df["rate"] = plot_df["rate"].apply(lambda x: x * 100)
+            plot_df = (
+                plot_df.drop(columns=["date"])
+                .set_index("maturity")
+                .filter(items=maturities, axis=0)
+                .reset_index()
+                .rename(columns={"maturity": "Maturity", "rate": "Yield"})
+            )
+            plot_df["Maturity"] = [
+                (
+                    d.split("_")[1] + " " + d.split("_")[0].title()
+                    if d != "long_term"
+                    else "Long Term"
+                )
+                for d in plot_df["Maturity"]
+            ]
+            figure.add_scatter(
+                x=plot_df["Maturity"],
+                y=plot_df["Yield"],
+                # fill=fill,
+                mode="lines+markers",
+                name=f"{country} - {date}" if country else date,
+                line=dict(width=3, color=color),
+                marker=dict(size=10, color=color),
+                hovertemplate=(
+                    "Maturity: %{x}<br>Yield: %{y}%<extra></extra>"
+                    if len(dates) == 1
+                    else "%{fullData.name}<br>Maturity: %{x}<br>Yield: %{y}%<extra></extra>"
+                ),
+            )
+            color_count += 1
+        return figure, color_count
+
+    dates = df.date.unique().tolist()
+    figure, color_count = create_fig(figure, df, dates, color_count)
+    extra_params = kwargs.get("extra_params")
+    extra_params = (
+        extra_params if isinstance(extra_params, dict) else extra_params.__dict__
+    )
+    # Set the title for the chart
+    country: str = ""
+    if provider in ("federal_reserve", "fmp"):
+        country = "United States"
+    elif provider == "ecb":
+        curve_type = extra_params.get("yield_curve_type", "").replace("_", " ").title()
+        grade = extra_params.get("rating", "").replace("_", " ")
+        grade = grade.upper() if grade == "aaa" else "All Ratings"
+        country = f"Euro Area ({grade}) {curve_type}"
+    elif provider == "fred":
+        curve_type = extra_params.get("yield_curve_type", "")
+        curve_type = (
+            "Real Rates"
+            if curve_type == "real"
+            else curve_type.replace("_", " ").title()
+        )
+        country = f"United States {curve_type}"
+    elif provider == "econdb":
+        country = extra_params.get("country", "")
+        country = country.replace("_", " ").title() if country else "United States"
+    country = country + " " if country else ""
+    title = kwargs.get("title", "")
+    if not title:
+        title = f"{country}Yield Curve"
+        if len(dates) == 1:
+            title = f"{country} Yield Curve - {dates[0]}"
+
+    # Update the layout of the figure.
+    figure.update_layout(
+        title=dict(text=title, x=0.5, font=dict(size=20)),
+        plot_bgcolor="rgba(255,255,255,0)",
+        xaxis=dict(
+            title="Maturity",
+            ticklen=0,
+            showgrid=False,
+            type="category",
+            categoryorder="array",
+            categoryarray=(
+                [
+                    (
+                        d.split("_")[1] + " " + d.split("_")[0].title()
+                        if d != "long_term"
+                        else "Long Term"
+                    )
+                    for d in maturities
+                ]
+            ),
+        ),
+        yaxis=dict(
+            title="Yield (%)",
+            ticklen=0,
+            showgrid=True,
+            gridcolor="rgba(128,128,128,0.3)",
+        ),
+        legend=dict(
+            orientation="v",
+            yanchor="top",
+            xanchor="right",
+            y=0.95,
+            x=0,
+            xref="paper",
+            font=dict(size=12),
+            bgcolor="rgba(0,0,0,0)",
+        ),
+        margin=dict(
+            b=25,
+            t=10,
+        ),
+    )
+
+    layout_kwargs = kwargs.get("layout_kwargs", {})
+    if layout_kwargs:
+        figure.update_layout(layout_kwargs)
+
+    content = figure.show(external=True)
+
+    return figure, content