[Release] Merge Release/4.3.4 From Main Into Develop

assets/extensions/provider.json

@@ -59,7 +59,7 @@
     {
         "packageName": "openbb-cftc",
         "optional": false,
-        "reprName": "Commodity DFutures Trading Commission (CFTC) Public Reporting API",
+        "reprName": "Commodity Futures Trading Commission (CFTC) Public Reporting API",
         "description": "The mission of the Commodity Futures Trading Commission (CFTC) is to promote the integrity,\n    resilience, and vibrancy of the U.S. derivatives markets through sound regulation.",
         "credentials": [
             "cftc_app_token"

cli/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-cli"
-version = "1.1.3"
+version = "1.1.4"
 description = "Investment Research for Everyone, Anywhere."
 authors = ["OpenBB <[email protected]>"]
 packages = [{ include = "openbb_cli" }]
@@ -17,7 +17,7 @@ openbb = 'openbb_cli.cli:main'
 python = "^3.9,<3.13"
 
 # OpenBB dependencies
-openbb = { version = "^4.3.3", extras = ["all"] }
+openbb = { version = "^4.3.4", extras = ["all"] }
 
 # CLI dependencies
 prompt-toolkit = "^3.0.16"

openbb_platform/README.md

@@ -24,20 +24,45 @@ pip install openbb
 
 This will install the following data providers:
 
-| Extension Name          | Description                                                               | Installation Command                | Minimum Subscription Type Required |
-| ----------------------- | ------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------- |
-| openbb-benzinga         | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector           | pip install openbb-benzinga         | Paid                               |
-| openbb-federal-reserve  | [FederalReserve](https://www.federalreserve.gov/data.html) data connector | pip install openbb-federal-reserve  | Free                               |
-| openbb-fmp              | [FMP](https://site.financialmodelingprep.com/developer/) data connector   | pip install openbb-fmp              | Free                               |
-| openbb-fred             | [FRED](https://fred.stlouisfed.org/) data connector                       | pip install openbb-fred             | Free                               |
-| openbb-intrinio         | [Intrinio](https://intrinio.com/pricing) data connector                   | pip install openbb-intrinio         | Paid                               |
-| openbb-oecd             | [OECD](https://data.oecd.org/) data connector                             | pip install openbb-oecd             | Free                               |
-| openbb-polygon          | [Polygon](https://polygon.io/) data connector                             | pip install openbb-polygon          | Free                               |
-| openbb-sec              | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector     | pip install openbb-sec              | Free                               |
-| openbb-tiingo           | [Tiingo](https://www.tiingo.com/about/pricing) data connector             | pip install openbb-tiingo           | Free                               |
-| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector       | pip install openbb-tradingeconomics | Paid                               |
-| openbb-yahoo-finance    | [Yahoo Finance](https://finance.yahoo.com/) data connector                | pip install openbb-yfinance         | Free                               |
-
+These packages are what will be installed when `pip install openbb` is run
+
+| Extension Name | Description | Installation Command | Minimum Subscription Type Required |
+|----------------|-------------|----------------------|------------------------------------|
+| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid |
+| openbb-bls | [Bureau of Labor Statistics](https://www.bls.gov/developers/home.htm) data connector | pip install openbb-bls | Free |
+| openbb-cftc | [Commodity Futures Trading Commission](https://publicreporting.cftc.gov/stories/s/r4w3-av2u) data connector | pip install openbb-cftc | Free |
+| openbb-econdb | [EconDB](https://econdb.com) data connector | pip install openbb-econdb | None |
+| openbb-imf | [IMF](https://data.imf.org) data connector | pip install openbb-imf | None |
+| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free |
+| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free |
+| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid |
+| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free |
+| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free |
+| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | None |
+| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free |
+| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid |
+| openbb-yfinance | [Yahoo Finance](https://finance.yahoo.com/) data connector | pip install openbb-yfinance | None |
+
+### Community Providers
+
+These packages are not installed when `pip install openbb` is run.  They are available for installation separately or by running `pip install openbb[all]`
+
+| Extension Name | Description | Installation Command | Minimum Subscription Type Required |
+|----------------|-------------|----------------------|------------------------------------|
+| openbb-alpha-vantage | [Alpha Vantage](https://www.alphavantage.co/) data connector | pip install openbb-alpha-vantage | Free |
+| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free |
+| openbb-cboe | [Cboe](https://www.cboe.com/delayed_quotes/) data connector | pip install openbb-cboe | None |
+| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | None |
+| openbb-federal-reserve | [Federal Reserve](https://www.federalreserve.gov/) data connector | pip install openbb-federal-reserve | None |
+| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | None / Free |
+| openbb-finviz | [Finviz](https://finviz.com) data connector | pip install openbb-finviz | None |
+| openbb-government-us | [US Government](https://data.gov) data connector | pip install openbb-us-government | None |
+| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector | pip install openbb-nasdaq | None / Free |
+| openbb-seeking-alpha | [Seeking Alpha](https://seekingalpha.com/) data connector | pip install openbb-seeking-alpha | None |
+| openbb-stockgrid | [Stockgrid](https://stockgrid.io) data connector | pip install openbb-stockgrid | None |
+| openbb-tmx | [TMX](https://money.tmx.com) data connector | pip install openbb-tmx | None |
+| openbb-tradier | [Tradier](https://tradier.com) data connector | pip install openbb-tradier | None |
+| openbb-wsj | [Wall Street Journal](https://www.wsj.com/) data connector | pip install openbb-wsj | None |
 To install extensions that expand the core functionalities specify the extension name or use `all` to install all.
 
 ```bash
@@ -128,15 +153,17 @@ The OpenBB Platform comes with a ready to use REST API built with FastAPI. Start
 uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
 ```
 
+API documentation is found under "/docs", from the root of the server address, and is viewable in any browser supporting HTTP over localhost, such as Chrome.
+
 Check `openbb-core` [README](https://pypi.org/project/openbb-core/) for additional info.
 
 ## Install for development
 
 To develop the OpenBB Platform you need to have the following:
 
 - Git
-- Python 3.8 or higher
-- Virtual Environment with `poetry` and `toml` packages installed
+- Python 3.9 or higher
+- Virtual Environment with `poetry` installed
   - To install these packages activate your virtual environment and run `pip install poetry toml`
 
 How to install the platform in editable mode?

openbb_platform/core/openbb_core/app/router.py

@@ -437,7 +437,7 @@ def polish_return_schema(func: Callable[P, OBBject]) -> Callable[P, OBBject]:
         if not isinstance(results_type, type(None)):
             results_type = results_type_args[0]
 
-        is_list = get_origin(results_type) == list
+        is_list = isinstance(get_origin(results_type), list)
         inner_type = (
             results_type_args[0] if is_list and results_type_args else results_type
         )