openbb-charting 2.1.2__tar.gz → 2.2.0__tar.gz

{openbb_charting-2.1.2 → openbb_charting-2.2.0}/PKG-INFO

@@ -1,19 +1,20 @@
 Metadata-Version: 2.1
 Name: openbb-charting
-Version: 2.1.2
+Version: 2.2.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
+Requires-Python: >=3.9,<3.13
 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
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: nbformat (>=5.9.2,<6.0.0)
-Requires-Dist: openbb-core (>=1.2.4,<2.0.0)
+Requires-Dist: numpy (>=1,<2)
+Requires-Dist: openbb-core (>=1.3.0,<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)
@@ -32,7 +33,7 @@ The library includes:
 - prebuilt charts for a set of commands that are built-in OpenBB extensions
 
 >[!NOTE]
-> The charting library is an [`OBBject` extension](https://docs.openbb.co/platform/development/developer-guidelines/obbject_extensions) which means you'll have the functionality it exposes on every command result.
+> The charting library is an `OBBject` extension which means you'll have the functionality it exposes on every command result.
 
 ## Installation
 
@@ -143,15 +144,44 @@ Example usage:
 
 ## Add a visualization to an existing Platform command
 
-One should first ensure that the already implemented endpoint is available in the [charting router](/openbb_platform/obbject_extensions/charting/openbb_charting/charting_router.py).
+To add a visualization to an existing command, you'll need to add a `poetry` plugin to your `pyproject.toml` file. The syntax should be the following:
 
-To do so, you can run:
- `python openbb_platform/obbject_extensions/charting/openbb_charting/builder.py` - which will read all the available endpoints and add them to the charting router.
+```toml
+[tool.poetry.plugins."openbb_charting_extension"]
+my_extension = "openbb_my_extension.my_extension_views:MyExtensionViews"
+```
+
+Where the `openbb_charting_extension` is **mandatory**, otherwise the charting extension won't be able to find the visualization.
+
+And the suggested structure for the `my_extension_views` module is the following:
+
+```python
+"""Views for MyExtension."""
+
+from typing import Any, Dict, Tuple
+
+from openbb_charting.charts.price_historical import price_historical
+from openbb_charting.core.openbb_figure import OpenBBFigure
+
+
+class MyExtensionViews:
+    """MyExtension Views."""
+
+    @staticmethod
+    def my_extension_price_historical(
+        **kwargs,
+    ) -> Tuple[OpenBBFigure, Dict[str, Any]]:
+        """MyExtension Price Historical Chart."""
+        return price_historical(**kwargs)
+```
+
+> Note that `my_extension_views` lives under the `openbb_my_extension` package.
 
-Afterwards, you'll need to add the visualization to the [charting router]. The convention to match the endpoint with the respective charting function is the following:
+Afterwards, you'll need to add the visualization to your new `MyExtensionViews` class. The convention to match the endpoint with the respective charting function is the following:
 
 - `/equity/price/historical` -> `equity_price_historical`
 - `/technical/ema` -> `technical_ema`
+- `/my_extension/price_historical` -> `my_extension_price_historical`
 
 When you spot the charting function on the charting router file, you can add the visualization to it.
 

{openbb_charting-2.1.2 → openbb_charting-2.2.0}/README.md

@@ -9,7 +9,7 @@ The library includes:
 - prebuilt charts for a set of commands that are built-in OpenBB extensions
 
 >[!NOTE]
-> The charting library is an [`OBBject` extension](https://docs.openbb.co/platform/development/developer-guidelines/obbject_extensions) which means you'll have the functionality it exposes on every command result.
+> The charting library is an `OBBject` extension which means you'll have the functionality it exposes on every command result.
 
 ## Installation
 
@@ -120,15 +120,44 @@ Example usage:
 
 ## Add a visualization to an existing Platform command
 
-One should first ensure that the already implemented endpoint is available in the [charting router](/openbb_platform/obbject_extensions/charting/openbb_charting/charting_router.py).
+To add a visualization to an existing command, you'll need to add a `poetry` plugin to your `pyproject.toml` file. The syntax should be the following:
 
-To do so, you can run:
- `python openbb_platform/obbject_extensions/charting/openbb_charting/builder.py` - which will read all the available endpoints and add them to the charting router.
+```toml
+[tool.poetry.plugins."openbb_charting_extension"]
+my_extension = "openbb_my_extension.my_extension_views:MyExtensionViews"
+```
+
+Where the `openbb_charting_extension` is **mandatory**, otherwise the charting extension won't be able to find the visualization.
+
+And the suggested structure for the `my_extension_views` module is the following:
+
+```python
+"""Views for MyExtension."""
+
+from typing import Any, Dict, Tuple
+
+from openbb_charting.charts.price_historical import price_historical
+from openbb_charting.core.openbb_figure import OpenBBFigure
+
+
+class MyExtensionViews:
+    """MyExtension Views."""
+
+    @staticmethod
+    def my_extension_price_historical(
+        **kwargs,
+    ) -> Tuple[OpenBBFigure, Dict[str, Any]]:
+        """MyExtension Price Historical Chart."""
+        return price_historical(**kwargs)
+```
+
+> Note that `my_extension_views` lives under the `openbb_my_extension` package.
 
-Afterwards, you'll need to add the visualization to the [charting router]. The convention to match the endpoint with the respective charting function is the following:
+Afterwards, you'll need to add the visualization to your new `MyExtensionViews` class. The convention to match the endpoint with the respective charting function is the following:
 
 - `/equity/price/historical` -> `equity_price_historical`
 - `/technical/ema` -> `technical_ema`
+- `/my_extension/price_historical` -> `my_extension_price_historical`
 
 When you spot the charting function on the charting router file, you can add the visualization to it.
 

openbb_charting-2.2.0/openbb_charting/__init__.py

@@ -0,0 +1,25 @@
+"""OpenBB OBBject extension for charting."""
+
+import warnings
+
+from openbb_core.app.model.extension import Extension
+
+warnings.filterwarnings(
+    "ignore",
+    category=UserWarning,
+    module="openbb_core.app.model.extension",
+)
+
+
+def get_charting_module():
+    """Get the Charting module."""
+    # pylint: disable=import-outside-toplevel
+    import importlib
+
+    _Charting = importlib.import_module("openbb_charting.charting").Charting
+    return _Charting
+
+
+ext = Extension(name="charting", description="Create custom charts from OBBject data.")
+
+Charting = ext.obbject_accessor(get_charting_module())

openbb_charting-2.1.2/openbb_charting/__init__.py → openbb_charting-2.2.0/openbb_charting/charting.py

@@ -1,44 +1,41 @@
-"""OpenBB OBBject extension for charting."""
+"""Charting Class implementation."""
 
 # pylint: disable=too-many-arguments,unused-argument
 
-import warnings
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
+    ClassVar,
     Dict,
     List,
     Literal,
     Optional,
     Tuple,
+    Type,
     Union,
 )
 from warnings import warn
 
-import numpy as np
-import pandas as pd
+from importlib_metadata import entry_points
 from openbb_core.app.model.charts.chart import Chart
-from openbb_core.app.model.extension import Extension
 from openbb_core.app.model.obbject import OBBject
-from openbb_core.app.utils import basemodel_to_df, convert_to_basemodel
 from openbb_core.provider.abstract.data import Data
-from plotly.graph_objs import Figure
 
-from openbb_charting import charting_router
-from openbb_charting.core.backend import Backend, create_backend, get_backend
-from openbb_charting.core.openbb_figure import OpenBBFigure
-from openbb_charting.query_params import ChartParams, IndicatorsParams
-from openbb_charting.utils.generic_charts import bar_chart, line_chart
-from openbb_charting.utils.helpers import get_charting_functions
-
-warnings.filterwarnings(
-    "ignore", category=UserWarning, module="openbb_core.app.model.extension", lineno=47
+from openbb_charting.charts.helpers import (
+    get_charting_functions,
+    get_charting_functions_list,
 )
 
-ext = Extension(name="charting", description="Create custom charts from OBBject data.")
+if TYPE_CHECKING:
+    from numpy import ndarray  # noqa
+    from pandas import DataFrame, Series  # noqa
+    from plotly.graph_objs import Figure  # noqa
+    from openbb_charting.core.openbb_figure import OpenBBFigure  # noqa
+    from openbb_charting.query_params import ChartParams  # noqa
+    from openbb_charting.core.backend import Backend  # noqa
 
 
-@ext.obbject_accessor
 class Charting:
     """Charting extension.
 
@@ -64,17 +61,29 @@ class Charting:
         Toggle the chart style, of an existing chart, between light and dark mode.
     """
 
+    _extension_views: ClassVar[List[Type]] = [
+        entry_point.load()
+        for entry_point in entry_points(group="openbb_charting_extension")
+    ]
+    _format = "plotly"  # the charts computed by this extension will be in plotly format
+
     def __init__(self, obbject):
         """Initialize Charting extension."""
         # pylint: disable=import-outside-toplevel
-        from openbb_core.app.model.charts.charting_settings import ChartingSettings
+        import importlib  # noqa
+
+        charting_settings_module = importlib.import_module(
+            "openbb_core.app.model.charts.charting_settings", "ChartingSettings"
+        )
+        ChartingSettings = charting_settings_module.ChartingSettings
 
         self._obbject: OBBject = obbject
         self._charting_settings = ChartingSettings(
             user_settings=self._obbject._user_settings,  # type: ignore
             system_settings=self._obbject._system_settings,  # type: ignore
         )
-        self._backend: Backend = self._handle_backend()
+        self._backend = self._handle_backend()
+        self._functions: Dict[str, Callable] = self._get_functions()
 
     @classmethod
     def indicators(cls):
@@ -82,33 +91,58 @@ class Charting:
 
         Without assigning to a variable, it will print the the information to the console.
         """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.query_params import IndicatorsParams
+
         return IndicatorsParams()
 
     @classmethod
-    def functions(cls):
+    def functions(cls) -> List[str]:
         """Return a list of the available functions."""
-        return get_charting_functions()
+        functions: List[str] = []
+        for view in cls._extension_views:
+            functions.extend(get_charting_functions_list(view))
+
+        return functions
+
+    def _get_functions(self) -> Dict[str, Callable]:
+        """Return a dict with the available functions."""
+        functions: Dict[str, Callable] = {}
+        for view in self._extension_views:
+            functions.update(get_charting_functions(view))
 
-    def _handle_backend(self) -> Backend:
+        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)
         return backend
 
-    @staticmethod
-    def _get_chart_function(route: str) -> Callable:
+    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:
             raise ValueError("OBBject was initialized with no function route.")
         adjusted_route = route.replace("/", "_")[1:]
-        return getattr(charting_router, adjusted_route)
+        if adjusted_route not in self._functions:
+            raise ValueError(
+                f"Could not find the route `{adjusted_route}` in the charting functions."
+            )
+        return self._functions[adjusted_route]
 
-    def get_params(self) -> ChartParams:
+    def get_params(self) -> Union["ChartParams", None]:
         """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 the class is not defined, the help for the function will be returned.
         """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.query_params import ChartParams
+
         if self._obbject._route is None:  # pylint: disable=protected-access
             raise ValueError("OBBject was initialized with no function route.")
         charting_function = (
@@ -116,23 +150,32 @@ class Charting:
         ).replace("/", "_")[1:]
         if hasattr(ChartParams, charting_function):
             return getattr(ChartParams, charting_function)()
-        raise ValueError(
-            f"Error: No chart parameters are defined for the route: {charting_function}"
+
+        return help(  # type: ignore
+            self._get_chart_function(  # pylint: disable=protected-access
+                self._obbject.extra[  # pylint: disable=protected-access
+                    "metadata"
+                ].route
+            )
         )
 
     def _prepare_data_as_df(
-        self, data: Optional[Union[pd.DataFrame, pd.Series]]
-    ) -> Tuple[pd.DataFrame, bool]:
+        self, data: Optional[Union["DataFrame", "Series"]]
+    ) -> Tuple["DataFrame", bool]:
         """Convert supplied data to a DataFrame."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_core.app.utils import basemodel_to_df, convert_to_basemodel
+        from pandas import DataFrame, Series
+
         has_data = (
-            isinstance(data, (Data, pd.DataFrame, pd.Series)) and not data.empty  # type: ignore
+            isinstance(data, (Data, DataFrame, Series)) and not data.empty  # type: ignore
         ) or (bool(data))
         index = (
             data.index.name
-            if has_data and isinstance(data, (pd.DataFrame, pd.Series))
+            if has_data and isinstance(data, (DataFrame, Series))
             else None
         )
-        data_as_df: pd.DataFrame = (
+        data_as_df: DataFrame = (
             basemodel_to_df(convert_to_basemodel(data), index=index)
             if has_data
             else self._obbject.to_dataframe(index=index)
@@ -149,11 +192,11 @@ class Charting:
         data: Union[
             list,
             dict,
-            pd.DataFrame,
-            List[pd.DataFrame],
-            pd.Series,
-            List[pd.Series],
-            np.ndarray,
+            "DataFrame",
+            List["DataFrame"],
+            "Series",
+            List["Series"],
+            "ndarray",
             Data,
         ],
         index: Optional[str] = None,
@@ -172,12 +215,12 @@ class Charting:
         same_axis: bool = False,
         render: bool = True,
         **kwargs,
-    ) -> Union[OpenBBFigure, Figure, None]:
+    ) -> Union["OpenBBFigure", "Figure", None]:
         """Create a line chart from external data and render a chart or return the OpenBBFigure.
 
         Parameters
         ----------
-        data : Union[Data, pd.DataFrame, pd.Series]
+        data : Union[Data, DataFrame, Series]
             Data to be plotted (OHLCV data).
         index : Optional[str], optional
             Index column, by default None
@@ -215,6 +258,9 @@ class Charting:
         **kwargs: Dict[str, Any]
             Extra parameters to be passed to `figure.show()`
         """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.charts.generic_charts import line_chart
+
         fig = line_chart(
             data=data,
             index=index,
@@ -244,11 +290,11 @@ class Charting:
         data: Union[
             list,
             dict,
-            pd.DataFrame,
-            List[pd.DataFrame],
-            pd.Series,
-            List[pd.Series],
-            np.ndarray,
+            "DataFrame",
+            List["DataFrame"],
+            "Series",
+            List["Series"],
+            "ndarray",
             Data,
         ],
         x: str,
@@ -266,12 +312,12 @@ class Charting:
         bar_kwargs: Optional[Dict[str, Any]] = None,
         render: bool = True,
         **kwargs,
-    ) -> Union[OpenBBFigure, Figure, None]:
+    ) -> Union["OpenBBFigure", "Figure", None]:
         """Create a bar chart on a single x-axis with one or more values for the y-axis.
 
         Parameters
         ----------
-        data : Union[list, dict, pd.DataFrame, List[pd.DataFrame], pd.Series, List[pd.Series], np.ndarray, Data]
+        data : Union[list, dict, DataFrame, List[DataFrame], Series, List[Series], ndarray, Data]
             Data to plot.
         x : str
             The x-axis column name.
@@ -298,6 +344,9 @@ class Charting:
         OpenBBFigure
             The OpenBBFigure object.
         """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.charts.generic_charts import bar_chart
+
         fig = bar_chart(
             data=data,
             x=x,
@@ -326,28 +375,19 @@ class Charting:
                 self._obbject._route  # pylint: disable=protected-access
             )
             kwargs["obbject_item"] = self._obbject.results
-            kwargs["charting_settings"] = self._charting_settings
-            if (
-                hasattr(self._obbject, "_standard_params")
-                and self._obbject._standard_params  # pylint: disable=protected-access
-            ):
-                kwargs["standard_params"] = (
-                    self._obbject._standard_params.__dict__  # pylint: disable=protected-access
-                )
-            kwargs["provider"] = (
-                self._obbject.provider
-            )  # pylint: disable=protected-access
-            kwargs["extra"] = self._obbject.extra  # pylint: disable=protected-access
-
-            if "kwargs" in kwargs:
-                _kwargs = kwargs.pop("kwargs")
-                kwargs.update(_kwargs.get("chart_params", {}))
+            kwargs["charting_settings"] = self._charting_settings  #
+            kwargs["standard_params"] = (
+                self._obbject._standard_params  # pylint: disable=protected-access
+            )
+            kwargs["extra_params"] = (
+                self._obbject._extra_params  # pylint: disable=protected-access
+            )
+            kwargs["provider"] = self._obbject.provider
+            kwargs["extra"] = self._obbject.extra
             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
-            )
+            self._obbject.chart = Chart(fig=fig, content=content, format=self._format)
             if render:
                 fig.show(**kwargs)
         except Exception:  # pylint: disable=W0718
@@ -356,7 +396,7 @@ class Charting:
                 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
+                    fig=fig, content=content, format=self._format
                 )
                 if render:
                     return fig.show(**kwargs)  # type: ignore
@@ -372,11 +412,11 @@ class Charting:
             Union[
                 list,
                 dict,
-                pd.DataFrame,
-                List[pd.DataFrame],
-                pd.Series,
-                List[pd.Series],
-                np.ndarray,
+                "DataFrame",
+                List["DataFrame"],
+                "Series",
+                List["Series"],
+                "ndarray",
                 Data,
             ]
         ] = None,
@@ -398,7 +438,7 @@ class Charting:
 
         Parameters
         ----------
-        data : Union[Data, pd.DataFrame, pd.Series]
+        data : Union[Data, DataFrame, Series]
             Data to be plotted.
         indicators : Dict[str, Dict[str, Any]], optional
             Indicators to be plotted, by default None
@@ -450,22 +490,14 @@ class Charting:
         kwargs["index"] = index
         kwargs["obbject_item"] = self._obbject.results
         kwargs["charting_settings"] = self._charting_settings
-        if (
-            hasattr(self._obbject, "_standard_params")
-            and self._obbject._standard_params  # pylint: disable=protected-access
-        ):
-            kwargs["standard_params"] = (
-                self._obbject._standard_params.__dict__  # pylint: disable=protected-access
-            )
-        kwargs["provider"] = self._obbject.provider  # pylint: disable=protected-access
-        kwargs["extra"] = self._obbject.extra  # pylint: disable=protected-access
-        metadata = kwargs["extra"].get("metadata")
+        kwargs["standard_params"] = (
+            self._obbject._standard_params  # pylint: disable=protected-access
+        )
         kwargs["extra_params"] = (
-            metadata.arguments.get("extra_params") if metadata else None
+            self._obbject._extra_params  # pylint: disable=protected-access
         )
-        if "kwargs" in kwargs:
-            _kwargs = kwargs.pop("kwargs")
-            kwargs.update(_kwargs.get("chart_params", {}))
+        kwargs["provider"] = self._obbject.provider  # pylint: disable=protected-access
+        kwargs["extra"] = self._obbject.extra  # pylint: disable=protected-access
         try:
             if has_data:
                 self.show(data=data_as_df, render=render, **kwargs)
@@ -477,7 +509,7 @@ class Charting:
                 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
+                    fig=fig, content=content, format=self._format
                 )
                 if render:
                     return fig.show(**kwargs)  # type: ignore
@@ -486,9 +518,9 @@ class Charting:
                     "Failed to automatically create a generic chart with the data provided."
                 ) from e
 
-    def _set_chart_style(self, figure: Figure):
+    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
+        style = self._charting_settings.chart_style
         font_color = "black" if style == "light" else "white"
         paper_bgcolor = "white" if style == "light" else "black"
         figure = figure.update_layout(
@@ -498,7 +530,7 @@ class Charting:
         )
         return figure
 
-    def toggle_chart_style(self):  # pylint: disable=protected-access
+    def toggle_chart_style(self):
         """Toggle the chart style between light and dark mode."""
         if not hasattr(self._obbject.chart, "fig"):
             raise ValueError(
@@ -516,21 +548,24 @@ class Charting:
 
     def table(
         self,
-        data: Optional[Union[pd.DataFrame, pd.Series]] = None,
+        data: Optional[Union["DataFrame", "Series"]] = None,
         title: str = "",
     ):
         """Display an interactive table.
 
         Parameters
         ----------
-        data : Optional[Union[pd.DataFrame, pd.Series]], optional
+        data : Optional[Union[DataFrame, Series]], optional
             Data to be plotted, by default None.
             If no data is provided the OBBject results will be used.
         title : str, optional
             Title of the table, by default "".
         """
+        # pylint: disable=import-outside-toplevel
+        from pandas import RangeIndex
+
         data_as_df, _ = self._prepare_data_as_df(data)
-        if isinstance(data_as_df.index, pd.RangeIndex):
+        if isinstance(data_as_df.index, RangeIndex):
             data_as_df.reset_index(inplace=True, drop=True)
         else:
             data_as_df.reset_index(inplace=True)
@@ -546,9 +581,7 @@ class Charting:
                 warn(f"Failed to show figure with backend. {e}")
 
         else:
-            from plotly import (  # pylint:disable=import-outside-toplevel
-                optional_imports,
-            )
+            from plotly import optional_imports
 
             ipython_display = optional_imports.get_module("IPython.display")
             if ipython_display: