Release/4.1.0

build/pypi/openbb_platform/publish.py

@@ -10,7 +10,7 @@
 EXTENSION_PACKAGES = ["extensions", "providers"]
 
 CMD = [sys.executable, "-m", "poetry"]
-EXTENSION_DEPENDENCIES_UPDATE_CMD = ["add", "openbb-core=latest"]
+EXTENSION_DEPENDENCIES_UPDATE_CMD = ["add", "openbb-core=latest", "--lock"]
 VERSION_BUMP_CMD = ["version", "prerelease"]
 PUBLISH_CMD = ["publish", "--build"]
 

openbb_platform/CONTRIBUTING.md

@@ -80,7 +80,7 @@ The OpenBB Platform is built by the Open-Source community and is characterized b
 The REST API is built on top of FastAPI and can be started by running the following command from the root:
 
 ```bash
-uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
+uvicorn openbb_platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
 ```
 
 The Python interfaces we provide to users is the `openbb` python package.
@@ -742,7 +742,7 @@ python openbb_platform/extensions/tests/utils/integration_tests_api_generator.py
 When testing the API interface, you'll need to run the OpenBB Platform locally before running the tests. To do so, you can run the following command:
 
 ```bash
-uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
+uvicorn openbb_platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
 ```
 
 These automated tests are a great way to reduce the amount of code you need to write, but they are not a replacement for manual testing and might require tweaking. That's why we have unit tests that test the generated integration tests to ensure they cover all providers and parameters.

openbb_platform/core/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-core"
-version = "1.0.1"
+version = "1.2.0"
 description = "OpenBB package with core functionality"
 authors = ["OpenBB Team <[email protected]>"]
 readme = "README.md"

openbb_platform/dev_install.py

@@ -47,8 +47,8 @@
 openbb-finra = { path = "./providers/finra", develop = true }
 openbb-nasdaq = { path = "./providers/nasdaq", optional = true, develop = true }
 openbb-seeking-alpha = { path = "./providers/seeking_alpha", optional = true, develop = true }
-openbb-stockgrid = { path = "./providers/stockgrid" ,optional = true,  develop = true }
-openbb-wsj = { path = "./providers/wsj", develop = true }
+openbb-stockgrid = { path = "./providers/stockgrid" , optional = true,  develop = true }
+openbb-wsj = { path = "./providers/wsj", optional = true, develop = true }
 openbb-yfinance = { path = "./providers/yfinance", optional = true, develop = true }
 
 openbb-charting = { path = "./extensions/charting", optional = true, develop = true }

openbb_platform/openbb/package/__extensions__.py

@@ -32,8 +32,11 @@ class Extensions(Container):
     - [email protected]
 
     - [email protected]
+    - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]
+    - [email protected]
     - [email protected]
     - [email protected]
     - [email protected]

openbb_platform/openbb/package/equity.py

@@ -14,6 +14,7 @@ class ROUTER_equity(Container):
     """/equity
     /calendar
     /compare
+    /darkpool
     /discovery
     /estimates
     /fundamental
@@ -45,6 +46,15 @@ def compare(self):
 
         return equity_compare.ROUTER_equity_compare(command_runner=self._command_runner)
 
+    @property
+    def darkpool(self):
+        # pylint: disable=import-outside-toplevel
+        from . import equity_darkpool
+
+        return equity_darkpool.ROUTER_equity_darkpool(
+            command_runner=self._command_runner
+        )
+
     @property
     def discovery(self):
         # pylint: disable=import-outside-toplevel

openbb_platform/openbb/package/equity_darkpool.py

@@ -0,0 +1,91 @@
+### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
+
+from typing import List, Literal, Optional, Union
+
+from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.static.container import Container
+from openbb_core.app.static.utils.decorators import validate
+from openbb_core.app.static.utils.filters import filter_inputs
+from typing_extensions import Annotated
+
+
+class ROUTER_equity_darkpool(Container):
+    """/equity/darkpool
+    otc
+    """
+
+    def __repr__(self) -> str:
+        return self.__doc__ or ""
+
+    @validate
+    def otc(
+        self,
+        symbol: Annotated[
+            Union[str, List[str]],
+            OpenBBCustomParameter(description="Symbol to get data for."),
+        ] = None,
+        provider: Optional[Literal["finra"]] = None,
+        **kwargs
+    ) -> OBBject:
+        """Weekly aggregate trade data for Over The Counter deals.
+
+        ATS and non-ATS trading data for each ATS/firm
+        with trade reporting obligations under FINRA rules.
+
+
+            Parameters
+            ----------
+            symbol : str
+                Symbol to get data for.
+            provider : Optional[Literal['finra']]
+                The provider to use for the query, by default None.
+                If None, the provider specified in defaults is selected or 'finra' if there is
+                no default.
+            tier : Literal['T1', 'T2', 'OTCE']
+                "T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products;
+                    T2 - All other NMS stocks; OTC - Over-the-Counter equity securities (provider: finra)
+            is_ats : bool
+                ATS data if true, NON-ATS otherwise (provider: finra)
+
+            Returns
+            -------
+            OBBject
+                results : List[OTCAggregate]
+                    Serializable results.
+                provider : Optional[Literal['finra']]
+                    Provider name.
+                warnings : Optional[List[Warning_]]
+                    List of warnings.
+                chart : Optional[Chart]
+                    Chart object.
+                extra: Dict[str, Any]
+                    Extra info.
+
+            OTCAggregate
+            ------------
+            update_date : date
+                Most recent date on which total trades is updated based on data received from each ATS/OTC.
+            share_quantity : float
+                Aggregate weekly total number of shares reported by each ATS for the Symbol.
+            trade_quantity : float
+                Aggregate weekly total number of trades reported by each ATS for the Symbol
+
+            Example
+            -------
+            >>> from openbb import obb
+            >>> obb.equity.darkpool.otc()
+        """  # noqa: E501
+
+        return self._run(
+            "/equity/darkpool/otc",
+            **filter_inputs(
+                provider_choices={
+                    "provider": provider,
+                },
+                standard_params={
+                    "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
+                },
+                extra_params=kwargs,
+            )
+        )