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

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

@@ -1,17 +1,19 @@
 Metadata-Version: 2.1
 Name: openbb-charting
-Version: 2.0.3
+Version: 2.1.0
 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.1,<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)

{openbb_charting-2.0.3 → openbb_charting-2.1.0}/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
@@ -467,27 +467,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 +538,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.0}/openbb_charting/core/backend.py

@@ -198,6 +198,12 @@ class Backend(PyWry):
         self.check_backend()
         # pylint: disable=C0415
 
+        paper_bg = (
+            "rgba(0,0,0,0)"
+            if self.charting_settings.chart_style == "dark"
+            else "rgba(255,255,255,0)"
+        )
+
         title = "Interactive Chart"
 
         fig.layout.title.text = re.sub(
@@ -210,9 +216,8 @@ class Backend(PyWry):
             export_image = Path(export_image).resolve()
 
         json_data = json.loads(fig.to_json())
-
         json_data.update(self.get_json_update(command_location))
-
+        json_data["layout"]["paper_bgcolor"] = paper_bg
         outgoing = dict(
             html=self.get_plotly_html(),
             json_data=json_data,

{openbb_charting-2.0.3 → openbb_charting-2.1.0}/pyproject.toml

@@ -1,8 +1,9 @@
 [tool.poetry]
 name = "openbb-charting"
-version = "2.0.3"
+version = "2.1.0"
 description = "Charting extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
+license = "AGPL-3.0-only"
 readme = "README.md"
 packages = [{ include = "openbb_charting" }]
 
@@ -16,7 +17,7 @@ pywry = "^0.6.1"
 svglib = "^1.5.1"
 nbformat = "^5.9.2"
 pandas-ta = "^0.3.14b"
-openbb-core = "^1.1.6"
+openbb-core = "^1.2.1"
 
 [build-system]
 requires = ["poetry-core"]