openbb-charting 2.5.0__tar.gz → 3.0.0__tar.gz

{openbb_charting-2.5.0 → openbb_charting-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openbb-charting
-Version: 2.5.0
+Version: 3.0.0
 Summary: Charting extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
@@ -14,11 +14,10 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: pywry
-Requires-Dist: nbformat (>=5.10.0,<6.0.0)
-Requires-Dist: openbb-core (>=1.6.0,<2.0.0)
-Requires-Dist: pandas-ta-openbb (>=0.4.23,<0.5.0)
+Requires-Dist: openbb-core (>=1.6.10,<2.0.0)
+Requires-Dist: pandas-ta-openbb (>=0.4.24,<0.5.0)
 Requires-Dist: plotly (>=6.3.1,<7.0.0)
-Requires-Dist: pywry (>=0.6.2,<0.7.0) ; extra == "pywry"
+Requires-Dist: pywry (>=2.0.2) ; extra == "pywry"
 Description-Content-Type: text/markdown
 
 # OpenBB Charting extension
@@ -42,14 +41,18 @@ To install the extension, run the following command in this folder:
 pip install openbb-charting
 ```
 
-## PyWry dependency on Linux
+To enable display in a native OS window, install the PyWry extra.
 
-The PyWry dependency handles the display of interactive charts and tables in a separate window. It is installed automatically with the OpenBB Charting extension.
+```bash
+pip install "openbb-charting[pywry]"
+```
+
+### PyWry dependency on Linux
 
 When using Linux distributions, the PyWry dependency requires certain dependencies to be installed first.
 
 - Debian-based / Ubuntu / Mint:
-`sudo apt install libwebkit2gtk-4.0-dev`
+`sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev`
 
 - Arch Linux / Manjaro:
 `sudo pacman -S webkit2gtk`
@@ -76,9 +79,7 @@ In order to display the chart, you need to call the `show()` method:
 equity_data.show()
 ```
 
-> Note: The `show()` method currently works either in a Jupyter Notebook or in a standalone python script with a PyWry based backend properly initialized.
-
-Alternatively, you can use the fact that the `openbb-charting` is an `OBBject` extension and use its available methods.
+Alternatively, `openbb-charting` is an `OBBject` accessor and its methods can be used directly from any instance.
 
 ```python
 from openbb import obb
@@ -88,9 +89,24 @@ res.charting.show()
 
 The above code will produce the same effect as the previous example.
 
+## Custom Charts and Data
+
+Various types of charts can be generated from Pandas DataFrames without needing to understand the Plotly library.
+
+The methods are exposed as part of the `OBBject` accessor class. The `data` parameter can be passed as a list object from `OBBject.results`, or any Pandas DataFrame instance.
+
+```python
+res = obb.equity.price.historical("AAPL", chart=True)
+
+surface_3d = res.charting.create_3d_surface
+bar_chart = res.charting.create_bar_chart
+line_chart = res.charting.create_line_chart
+correlation_matrix = res.charting.create_correlation_matrix
+```
+
 ### Discovering available charts
 
-Not all the endpoints are currently supported by the charting extension. To discover which endpoints are supported, you can run the following command:
+Not all the endpoints have dedicated charts. To discover which endpoints are supported, you can run the following command:
 
 ```python
 from openbb_charting import Charting
@@ -191,8 +207,8 @@ The implementation should leverage the already existing classes and methods to d
 
 Note that the return of each charting function should respect the already defined return types: `Tuple[OpenBBFigure, Dict[str, Any]]`.
 
-The returned tuple contains a `OpenBBFigure` that is an interactive plotly figure which can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
+The returned tuple contains a `OpenBBFigure` that is an interactive Plotly figure which can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
 
 After you're done implementing the charting function, you can use either the Python interface or the API to get the chart. To do so, you'll only need to set the already available `chart` argument to `True`.
-Or accessing the `charting` attribute of the `OBBject` object: `my_obbject.charting.show()`.
+Or accessing the `charting` attribute of any returned `OBBject` object: `my_obbject.charting.show()`.
 

{openbb_charting-2.5.0 → openbb_charting-3.0.0}/README.md

@@ -19,14 +19,18 @@ To install the extension, run the following command in this folder:
 pip install openbb-charting
 ```
 
-## PyWry dependency on Linux
+To enable display in a native OS window, install the PyWry extra.
 
-The PyWry dependency handles the display of interactive charts and tables in a separate window. It is installed automatically with the OpenBB Charting extension.
+```bash
+pip install "openbb-charting[pywry]"
+```
+
+### PyWry dependency on Linux
 
 When using Linux distributions, the PyWry dependency requires certain dependencies to be installed first.
 
 - Debian-based / Ubuntu / Mint:
-`sudo apt install libwebkit2gtk-4.0-dev`
+`sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev`
 
 - Arch Linux / Manjaro:
 `sudo pacman -S webkit2gtk`
@@ -53,9 +57,7 @@ In order to display the chart, you need to call the `show()` method:
 equity_data.show()
 ```
 
-> Note: The `show()` method currently works either in a Jupyter Notebook or in a standalone python script with a PyWry based backend properly initialized.
-
-Alternatively, you can use the fact that the `openbb-charting` is an `OBBject` extension and use its available methods.
+Alternatively, `openbb-charting` is an `OBBject` accessor and its methods can be used directly from any instance.
 
 ```python
 from openbb import obb
@@ -65,9 +67,24 @@ res.charting.show()
 
 The above code will produce the same effect as the previous example.
 
+## Custom Charts and Data
+
+Various types of charts can be generated from Pandas DataFrames without needing to understand the Plotly library.
+
+The methods are exposed as part of the `OBBject` accessor class. The `data` parameter can be passed as a list object from `OBBject.results`, or any Pandas DataFrame instance.
+
+```python
+res = obb.equity.price.historical("AAPL", chart=True)
+
+surface_3d = res.charting.create_3d_surface
+bar_chart = res.charting.create_bar_chart
+line_chart = res.charting.create_line_chart
+correlation_matrix = res.charting.create_correlation_matrix
+```
+
 ### Discovering available charts
 
-Not all the endpoints are currently supported by the charting extension. To discover which endpoints are supported, you can run the following command:
+Not all the endpoints have dedicated charts. To discover which endpoints are supported, you can run the following command:
 
 ```python
 from openbb_charting import Charting
@@ -168,7 +185,7 @@ The implementation should leverage the already existing classes and methods to d
 
 Note that the return of each charting function should respect the already defined return types: `Tuple[OpenBBFigure, Dict[str, Any]]`.
 
-The returned tuple contains a `OpenBBFigure` that is an interactive plotly figure which can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
+The returned tuple contains a `OpenBBFigure` that is an interactive Plotly figure which can be used in a Python interpreter, and a `Dict[str, Any]` that contains the raw data leveraged by the API.
 
 After you're done implementing the charting function, you can use either the Python interface or the API to get the chart. To do so, you'll only need to set the already available `chart` argument to `True`.
-Or accessing the `charting` attribute of the `OBBject` object: `my_obbject.charting.show()`.
+Or accessing the `charting` attribute of any returned `OBBject` object: `my_obbject.charting.show()`.

{openbb_charting-2.5.0 → openbb_charting-3.0.0}/openbb_charting/charting.py

@@ -29,7 +29,6 @@ if TYPE_CHECKING:
     from plotly.graph_objs import Figure
     from openbb_charting.core.openbb_figure import OpenBBFigure
     from openbb_charting.query_params import ChartParams
-    from openbb_charting.core.backend import Backend
 
 
 class Charting:
@@ -70,6 +69,8 @@ class Charting:
         # pylint: disable=import-outside-toplevel
         import importlib  # noqa
 
+        from openbb_charting.core.backend import Backend
+
         charting_settings_module = importlib.import_module(
             "openbb_core.app.model.charts.charting_settings", "ChartingSettings"
         )
@@ -80,7 +81,7 @@ class Charting:
             user_settings=self._obbject._user_settings,  # type: ignore
             system_settings=self._obbject._system_settings,  # type: ignore
         )
-        self._backend = self._handle_backend()
+        self._backend = Backend(self._charting_settings)
         self._functions: dict[str, Callable] = self._get_functions()
 
     @classmethod
@@ -111,16 +112,6 @@ class Charting:
 
         return functions
 
-    def _handle_backend(self) -> "Backend":
-        """Create and start the backend."""
-        # pylint: disable=import-outside-toplevel
-        from openbb_charting.core.backend import create_backend, get_backend
-
-        create_backend(self._charting_settings)
-        backend = get_backend()
-        backend.start(debug=self._charting_settings.debug_mode)  # type: ignore
-        return backend  # type: ignore
-
     def _get_chart_function(self, route: str) -> Callable:
         """Given a route, it returns the chart function. The module must contain the given route."""
         if route is None:
@@ -477,7 +468,7 @@ class Charting:
 
         try:
             charting_function = self._get_chart_function(
-                self._obbject._route  # pylint: disable=protected-access   # type: ignore
+                self._obbject._route or ""  # pylint: disable=protected-access
             )
             kwargs["obbject_item"] = self._obbject.results
             kwargs["charting_settings"] = self._charting_settings
@@ -495,6 +486,10 @@ class Charting:
 
             kwargs["provider"] = self._obbject.provider
             kwargs["extra"] = self._obbject.extra
+            kwargs.setdefault(
+                "command_location",
+                self._obbject._route or "",  # pylint: disable=protected-access
+            )
 
             # Handle different types of output from the charting endpoint.
             chart_response: Any = charting_function(**kwargs)
@@ -666,21 +661,12 @@ class Charting:
 
     def _set_chart_style(self, figure: "Figure"):
         """Set the user preference for light or dark mode."""
-        style = self._charting_settings.chart_style
-        font_color = "black" if style == "light" else "white"
-        paper_bgcolor = "white" if style == "light" else "black"
-        plot_bgcolor = "white" if style == "light" else "black"
-        figure = figure.update_layout(
-            dict(
-                font_color=font_color,
-                paper_bgcolor=paper_bgcolor,
-                plot_bgcolor=plot_bgcolor,
-            )
-        )  # pylint: disable=R1735
         return figure
 
     def toggle_chart_style(self):
         """Toggle the chart style between light and dark mode."""
+        import plotly.io as pio  # pylint: disable=import-outside-toplevel
+
         if not hasattr(self._obbject.chart, "fig"):
             raise ValueError(
                 "Error: No chart has been created. Please create a chart first."
@@ -688,10 +674,11 @@ class Charting:
         current = self._charting_settings.chart_style
         new = "light" if current == "dark" else "dark"
         self._charting_settings.chart_style = new
+        template_name = "plotly_white" if new == "light" else "plotly_dark"
         figure = self._obbject.chart.fig  # type: ignore[union-attr]
-        updated_figure = self._set_chart_style(figure)  # type: ignore[union-attr]
-        self._obbject.chart.fig = updated_figure  # type: ignore[union-attr]
-        self._obbject.chart.content = updated_figure.show(  # type: ignore[union-attr]
+        figure.update_layout(template=pio.templates[template_name])  # type: ignore[union-attr]
+        self._obbject.chart.fig = figure  # type: ignore[union-attr]
+        self._obbject.chart.content = figure.show(  # type: ignore[union-attr]
             external=True
         ).to_plotly_json()  # type: ignore[union-attr]
 
@@ -725,6 +712,7 @@ class Charting:
         self,
         data: Union["DataFrame", "Series"] | None = None,
         title: str = "",
+        include_query_toolbar: bool = True,
     ):
         """Display an interactive table.
 
@@ -735,6 +723,8 @@ class Charting:
             If no data is provided the OBBject results will be used.
         title : str, optional
             Title of the table, by default "".
+        include_query_toolbar : bool, optional
+            Whether to include the Pandas Query toolbar, by default True.
         """
         # pylint: disable=import-outside-toplevel
         from pandas import RangeIndex
@@ -746,26 +736,27 @@ class Charting:
             data_as_df.reset_index(inplace=True)
         for col in data_as_df.columns:
             data_as_df[col] = data_as_df[col].apply(self._convert_to_string)
-        if self._backend.isatty:
-            try:
-                self._backend.send_table(
+        try:
+            send_table = getattr(self._backend, "send_table")
+            if include_query_toolbar:
+                send_table(
                     df_table=data_as_df,
                     title=title
-                    or ""
-                    or self._obbject._route,  # pylint: disable=protected-access  # type: ignore
+                    or self._obbject._route  # pylint: disable=protected-access
+                    or "",
                     theme=self._charting_settings.table_style,  # pylint: disable=protected-access
                 )
-            except Exception as e:  # pylint: disable=W0718
-                warn(f"Failed to show figure with backend. {e}")
-
-        else:
-            from plotly import optional_imports
-
-            ipython_display = optional_imports.get_module("IPython.display")
-            if ipython_display:
-                ipython_display.display(ipython_display.HTML(data_as_df.to_html()))
             else:
-                warn("IPython.display is not available.")
+                send_table(
+                    df_table=data_as_df,
+                    title=title
+                    or self._obbject._route  # pylint: disable=protected-access
+                    or "",
+                    theme=self._charting_settings.table_style,  # pylint: disable=protected-access
+                    include_query_toolbar=False,
+                )
+        except Exception as e:  # pylint: disable=W0718
+            warn(f"Failed to show table with backend. {e}")
 
     def url(
         self,

{openbb_charting-2.5.0 → openbb_charting-3.0.0}/openbb_charting/charts/generic_charts.py

@@ -124,7 +124,6 @@ def line_chart(  # noqa: PLR0912
     except Exception as _:
         fig = OpenBBFigure(create_backend=True)
 
-    fig.update_layout(ChartStyle().plotly_template.get("layout", {}))
     text_color = "white" if ChartStyle().plt_style == "dark" else "black"
     title = f"{title}" if title else ""
     xtitle = xtitle if xtitle else ""
@@ -245,7 +244,6 @@ def line_chart(  # noqa: PLR0912
 
     fig.update_layout(
         title=dict(text=title if title else None, x=0.5, font=dict(size=16)),
-        font=dict(color=text_color),
         legend=dict(
             orientation="v",
             yanchor="top",
@@ -410,7 +408,6 @@ def bar_chart(  # noqa: PLR0912
         specs=[[{"secondary_y": True}]],
     )
 
-    figure.update_layout(ChartStyle().plotly_template.get("layout", {}))
     text_color = "white" if ChartStyle().plt_style == "dark" else "black"
     if colors is not None:
         figure.update_layout(colorway=colors)
@@ -486,7 +483,6 @@ def bar_chart(  # noqa: PLR0912
         ),
         margin=dict(pad=5),
         barmode=barmode,
-        font=dict(color=text_color),
     )
     if orientation == "h":
         figure.update_layout(
@@ -567,8 +563,6 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
         row_width=[1],
         specs=[[{"secondary_y": True}]],
     )
-    figure.update_layout(ChartStyle().plotly_template.get("layout", {}))
-    text_color = "white" if ChartStyle().plt_style == "dark" else "black"
 
     try:
         data = Series(data=values, index=keys)
@@ -625,7 +619,6 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
             categoryorder="array" if orientation == "v" else None,
             categoryarray=keys if orientation == "v" else None,
         ),
-        font=dict(color="white" if text_color == "white" else "black"),
         margin=dict(pad=5),
     )
 
@@ -696,8 +689,6 @@ def surface3d(
     chart_style = ChartStyle()
     if theme:
         chart_style.plt_style = theme
-    fig.update_layout(chart_style.plotly_template.get("layout", {}))
-    text_color = "white" if chart_style.plt_style == "dark" else "black"
     fig.set_title(f"{title if title and title != 'OpenBB Platform' else ''}")
     fig_kwargs = dict(z=Z, x=X, y=Y, i=II, j=J, k=K, intensity=Z)
     customdata = np.array([[xtitle, ytitle, ztitle]] * len(X))
@@ -784,7 +775,6 @@ def surface3d(
             center=dict(x=-0.01, y=0, z=-0.3),
             eye=dict(x=1.75, y=1.75, z=0.69),
         ),
-        font=dict(color=text_color),
     )
 
     fig.update_scenes(

{openbb_charting-2.5.0 → openbb_charting-3.0.0}/openbb_charting/charts/price_historical.py

@@ -120,7 +120,6 @@ def price_historical(  # noqa: PLR0912
         if _volume is True and "atr" in indicators:  # type: ignore
             fig.add_inchart_volume(data)
         fig.update_layout(
-            font=dict(color=text_color),
             showlegend=True,
             legend=dict(
                 orientation="v",
@@ -206,7 +205,6 @@ def price_historical(  # noqa: PLR0912
                 y2title = None  # type: ignore
 
         fig = OpenBBFigure()
-        fig.update_layout(ChartStyle().plotly_template.get("layout", {}))
         text_color = "white" if ChartStyle().plt_style == "dark" else "black"
 
         for i, col in enumerate(data.columns):