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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openbb-charting
-Version: 2.1.2
+Version: 2.1.3
 Summary: Charting extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
@@ -32,7 +32,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 +143,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.1.3}/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.1.3/openbb_charting/__init__.py

@@ -0,0 +1,14 @@
+"""OpenBB OBBject extension for charting."""
+
+import warnings
+
+from openbb_core.app.model.extension import Extension
+
+from openbb_charting.charting import Charting as _Charting
+
+warnings.filterwarnings(
+    "ignore", category=UserWarning, module="openbb_core.app.model.extension", lineno=47
+)
+
+ext = Extension(name="charting", description="Create custom charts from OBBject data.")
+Charting = ext.obbject_accessor(_Charting)

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

@@ -1,44 +1,40 @@
-"""OpenBB OBBject extension for charting."""
+"""Charting Class implementation."""
 
 # pylint: disable=too-many-arguments,unused-argument
 
-import warnings
 from typing import (
     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.charts.generic_charts import bar_chart, line_chart
+from openbb_charting.charts.helpers import (
+    get_charting_functions,
+    get_charting_functions_list,
+)
 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
-)
 
-ext = Extension(name="charting", description="Create custom charts from OBBject data.")
 
-
-@ext.obbject_accessor
 class Charting:
     """Charting extension.
 
@@ -64,6 +60,11 @@ 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")
+    ]
+
     def __init__(self, obbject):
         """Initialize Charting extension."""
         # pylint: disable=import-outside-toplevel
@@ -75,6 +76,7 @@ class Charting:
             system_settings=self._obbject._system_settings,  # type: ignore
         )
         self._backend: Backend = self._handle_backend()
+        self._functions: Dict[str, Callable] = self._get_functions()
 
     @classmethod
     def indicators(cls):
@@ -85,9 +87,21 @@ class Charting:
         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))
+
+        return functions
 
     def _handle_backend(self) -> Backend:
         """Create and start the backend."""
@@ -96,13 +110,16 @@ class Charting:
         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:
         """Return the ChartQueryParams class for the function the OBBject was created from.
@@ -326,28 +343,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)
             if render:
                 fig.show(**kwargs)
         except Exception:  # pylint: disable=W0718
@@ -355,9 +363,7 @@ class Charting:
                 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
-                )
+                self._obbject.chart = Chart(fig=fig, content=content)
                 if render:
                     return fig.show(**kwargs)  # type: ignore
             except Exception as e:
@@ -450,22 +456,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)
@@ -476,9 +474,7 @@ class Charting:
                 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
-                )
+                self._obbject.chart = Chart(fig=fig, content=content)
                 if render:
                     return fig.show(**kwargs)  # type: ignore
             except Exception as e:  # pylint: disable=W0718
@@ -488,7 +484,7 @@ class Charting:
 
     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 +494,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(

{openbb_charting-2.1.2/openbb_charting/utils → openbb_charting-2.1.3/openbb_charting/charts}/generic_charts.py

@@ -10,14 +10,14 @@ 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.core.chart_style import ChartStyle
-from openbb_charting.core.openbb_figure import OpenBBFigure
-from openbb_charting.styles.colors import LARGE_CYCLER
-from openbb_charting.utils.helpers import (
+from openbb_charting.charts.helpers import (
     calculate_returns,
     should_share_axis,
     z_score_standardization,
 )
+from openbb_charting.core.chart_style import ChartStyle
+from openbb_charting.core.openbb_figure import OpenBBFigure
+from openbb_charting.styles.colors import LARGE_CYCLER
 
 
 def line_chart(  # noqa: PLR0912
@@ -48,7 +48,6 @@ def line_chart(  # noqa: PLR0912
     **kwargs,
 ) -> Union[OpenBBFigure, Figure]:
     """Create a line chart."""
-
     if data is None:
         raise ValueError("Error: Data is a required field.")
 
@@ -381,7 +380,6 @@ def bar_chart(  # noqa: PLR0912
     OpenBBFigure
         The OpenBBFigure object.
     """
-
     try:
         figure = OpenBBFigure()
     except Exception as _:
@@ -523,7 +521,6 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
     OpenBBFigure
         The OpenBBFigure object.
     """
-
     try:
         figure = OpenBBFigure()
     except Exception as _:

{openbb_charting-2.1.2/openbb_charting/utils → openbb_charting-2.1.3/openbb_charting/charts}/helpers.py

@@ -1,31 +1,32 @@
 """Helper functions for charting."""
 
-import importlib
 from inspect import getmembers, getsource, isfunction
-from typing import List
+from typing import Callable, Dict, List, Type
 
 import pandas as pd
 from pandas_ta import candles
 
 
-def get_charting_functions() -> List[str]:
+def get_charting_functions(view: Type) -> Dict[str, Callable]:
     """Discover charting functions."""
+    implemented_functions: Dict[str, Callable] = {}
 
-    charting_router = importlib.import_module("openbb_charting.charting_router")
-
-    implemented_functions = []
-
-    for name, obj in getmembers(charting_router, isfunction):
+    for name, obj in getmembers(view, isfunction):
         if (
-            obj.__module__ == charting_router.__name__
+            obj.__module__ == view.__module__
             and not name.startswith("_")
             and "NotImplementedError" not in getsource(obj)
         ):
-            implemented_functions.append(name)
+            implemented_functions[name] = obj
 
     return implemented_functions
 
 
+def get_charting_functions_list(view: Type) -> List[str]:
+    """Get a list of all the charting functions."""
+    return list(get_charting_functions(view).keys())
+
+
 def z_score_standardization(data: pd.Series) -> pd.Series:
     """Z-Score Standardization Method."""
     return (data - data.mean()) / data.std()
@@ -68,7 +69,6 @@ def heikin_ashi(data: pd.DataFrame) -> pd.DataFrame:
     pd.DataFrame
         DataFrame copy with Heikin Ashi candle calculations.
     """
-
     df = data.copy()
 
     check_columns = ["open", "high", "low", "close"]