jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

build package

Browse Source
This commit is contained in:
tehcoderer
2023-08-11 11:24:12 -04:00
parent f943bc838a
commit ef3e703ccc
15 changed files with 285 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py
View File

@@ -5,42 +5,12 @@ from openbb_core.app.static.container import Container
class Extensions(Container):
@property
def forex(self): # route = "/forex"
from openbb_core.app.static.package import forex
return forex.CLASS_forex(command_runner_session=self._command_runner_session)
@property
def qa(self): # route = "/qa"
from openbb_core.app.static.package import qa
return qa.CLASS_qa(command_runner_session=self._command_runner_session)
@property
def crypto(self): # route = "/crypto"
from openbb_core.app.static.package import crypto
return crypto.CLASS_crypto(command_runner_session=self._command_runner_session)
@property
def news(self): # route = "/news"
from openbb_core.app.static.package import news
return news.CLASS_news(command_runner_session=self._command_runner_session)
@property
def stocks(self): # route = "/stocks"
from openbb_core.app.static.package import stocks
return stocks.CLASS_stocks(command_runner_session=self._command_runner_session)
@property
def ta(self): # route = "/ta"
from openbb_core.app.static.package import ta
return ta.CLASS_ta(command_runner_session=self._command_runner_session)
@property
def economy(self): # route = "/economy"
from openbb_core.app.static.package import economy
@@ -56,3 +26,33 @@ class Extensions(Container):
return fixedincome.CLASS_fixedincome(
command_runner_session=self._command_runner_session
)
@property
def forex(self): # route = "/forex"
from openbb_core.app.static.package import forex
return forex.CLASS_forex(command_runner_session=self._command_runner_session)
@property
def news(self): # route = "/news"
from openbb_core.app.static.package import news
return news.CLASS_news(command_runner_session=self._command_runner_session)
@property
def qa(self): # route = "/qa"
from openbb_core.app.static.package import qa
return qa.CLASS_qa(command_runner_session=self._command_runner_session)
@property
def stocks(self): # route = "/stocks"
from openbb_core.app.static.package import stocks
return stocks.CLASS_stocks(command_runner_session=self._command_runner_session)
@property
def ta(self): # route = "/ta"
from openbb_core.app.static.package import ta
return ta.CLASS_ta(command_runner_session=self._command_runner_session)

49
openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py
View File

@@ -1,9 +1,9 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
from typing import Annotated, List, Literal, Optional, Union
from typing import Annotated, Literal, Optional, Union
from pydantic import validate_arguments
from pydantic import BaseModel, validate_arguments
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
@@ -34,8 +34,8 @@ class CLASS_crypto(Container):
chart: bool = False,
provider: Optional[Literal["fmp", "polygon", "yfinance"]] = None,
**kwargs,
) -> CommandOutput[List]:
r"""Crypto Intraday Price.
) -> CommandOutput[BaseModel]:
"""Crypto Intraday Price.
openbb
@@ -102,11 +102,48 @@ class CLASS_crypto(Container):
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
Change \\% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time."""
Change \\% in the price of the symbol over a period of time.
polygon
=======
Parameters
----------
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
The timespan of the data.
sort : Literal['asc', 'desc']
Sort order of the data.
limit : PositiveInt
The number of data entries to return.
adjusted : bool
Whether the data is adjusted.
multiplier : PositiveInt
The multiplier of the timespan.
CryptoEOD
---------
n : PositiveInt
The number of transactions for the symbol in the time period.
yfinance
========
Parameters
----------
interval : Optional[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo']]
Data granularity.
period : Optional[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max']]
Period of the data to return (quarterly or annually).
CryptoEOD
---------
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,

32
openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py
View File

@@ -1,7 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
import typing
from typing import Annotated, List, Literal, Optional, Union
from pydantic import BaseModel, validate_arguments
@@ -52,7 +51,7 @@ class CLASS_economy(Container):
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Get the constituents of an index.
@@ -197,7 +196,7 @@ class CLASS_economy(Container):
Literal["monthly", "quarterly", "annual"],
OpenBBCustomParameter(description="The data time frequency."),
] = "monthly",
harmonized: typing.Annotated[
harmonized: Annotated[
bool,
OpenBBCustomParameter(
description="Whether you wish to obtain harmonized data."
@@ -330,7 +329,7 @@ class CLASS_economy(Container):
@validate_arguments
def index(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
start_date: Annotated[
@@ -348,8 +347,8 @@ class CLASS_economy(Container):
chart: bool = False,
provider: Optional[Literal["fmp", "polygon", "yfinance"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
r"""Get OHLCV data for an index.
) -> CommandOutput[BaseModel]:
"""Get OHLCV data for an index.
openbb
@@ -459,22 +458,7 @@ class CLASS_economy(Container):
MajorIndicesEOD
---------------
date : datetime
The date of the data.
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
vwap : float
Volume Weighted Average Price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time."""
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -499,7 +483,7 @@ class CLASS_economy(Container):
@validate_arguments
def available_indices(
self, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""AVAILABLE_INDICES.
@@ -571,7 +555,7 @@ class CLASS_economy(Container):
@validate_arguments
def risk(
self, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Market Risk Premium.

7
openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py
View File

@@ -1,8 +1,7 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Annotated, List, Literal, Optional, Union
from pydantic import validate_arguments
@@ -33,8 +32,8 @@ class CLASS_fixedincome(Container):
] = None,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Get treasury rates.

26
openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py
View File

@@ -1,10 +1,9 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Annotated, List, Literal, Optional, Union
from pydantic import validate_arguments
from pydantic import BaseModel, validate_arguments
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
@@ -20,7 +19,7 @@ class CLASS_forex(Container):
chart: bool = False,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Forex Available Pairs.
@@ -131,7 +130,7 @@ class CLASS_forex(Container):
@validate_arguments
def load(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
start_date: Annotated[
@@ -149,8 +148,8 @@ class CLASS_forex(Container):
chart: bool = False,
provider: Optional[Literal["fmp", "polygon", "yfinance"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
r"""Forex Intraday Price.
) -> CommandOutput[BaseModel]:
"""Forex Intraday Price.
openbb
@@ -257,18 +256,7 @@ class CLASS_forex(Container):
ForexEOD
--------
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time."""
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,

92
openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json vendored
View File

@@ -1,8 +1,51 @@
{
"forex_pairs": "/forex/pairs",
"crypto_load": "/crypto/load",
"__extensions__": "",
"crypto": "/crypto",
"economy_corecpi": "/economy/corecpi",
"economy": "/economy",
"economy_const": "/economy/const",
"economy_cpi": "/economy/cpi",
"economy_cpi_options": "/economy/cpi_options",
"economy_index": "/economy/index",
"economy_available_indices": "/economy/available_indices",
"economy_risk": "/economy/risk",
"economy_macro": "/economy/macro",
"economy_macro_countries": "/economy/macro_countries",
"economy_macro_parameters": "/economy/macro_parameters",
"economy_balance": "/economy/balance",
"economy_bigmac": "/economy/bigmac",
"economy_country_codes": "/economy/country_codes",
"economy_currencies": "/economy/currencies",
"economy_debt": "/economy/debt",
"economy_events": "/economy/events",
"economy_fgdp": "/economy/fgdp",
"economy_fred": "/economy/fred",
"economy_fred_search": "/economy/fred_search",
"economy_futures": "/economy/futures",
"economy_gdp": "/economy/gdp",
"economy_glbonds": "/economy/glbonds",
"economy_indices": "/economy/indices",
"economy_overview": "/economy/overview",
"economy_perfmap": "/economy/perfmap",
"economy_performance": "/economy/performance",
"economy_revenue": "/economy/revenue",
"economy_rgdp": "/economy/rgdp",
"economy_rtps": "/economy/rtps",
"economy_search_index": "/economy/search_index",
"economy_spending": "/economy/spending",
"economy_trust": "/economy/trust",
"economy_usbonds": "/economy/usbonds",
"economy_valuation": "/economy/valuation",
"fixedincome_treasury": "/fixedincome/treasury",
"fixedincome": "/fixedincome",
"fixedincome_ycrv": "/fixedincome/ycrv",
"forex_pairs": "/forex/pairs",
"forex": "/forex",
"forex_load": "/forex/load",
"news_globalnews": "/news/globalnews",
"news": "/news",
"news_sectornews": "/news/sectornews",
"qa_normality": "/qa/normality",
"qa": "/qa",
"qa_capm": "/qa/capm",
@@ -29,11 +72,6 @@
"qa_es": "/qa/es",
"qa_acf": "/qa/acf",
"qa_summary": "/qa/summary",
"crypto_load": "/crypto/load",
"crypto": "/crypto",
"news_globalnews": "/news/globalnews",
"news": "/news",
"news_sectornews": "/news/sectornews",
"stocks_fa_analysis": "/stocks/fa/analysis",
"stocks": "/stocks",
"stocks_fa": "/stocks/fa",
@@ -171,6 +209,8 @@
"stocks_multiples": "/stocks/multiples",
"stocks_tob": "/stocks/tob",
"stocks_search": "/stocks/search",
"stocks_quote": "/stocks/quote",
"stocks_info": "/stocks/info",
"ta_atr": "/ta/atr",
"ta": "/ta",
"ta_fib": "/ta/fib",
@@ -202,43 +242,5 @@
"ta_kc": "/ta/kc",
"ta_cg": "/ta/cg",
"ta_cones": "/ta/cones",
"ta_ema": "/ta/ema",
"economy_corecpi": "/economy/corecpi",
"economy": "/economy",
"economy_const": "/economy/const",
"economy_cpi": "/economy/cpi",
"economy_cpi_options": "/economy/cpi_options",
"economy_index": "/economy/index",
"economy_available_indices": "/economy/available_indices",
"economy_risk": "/economy/risk",
"economy_macro": "/economy/macro",
"economy_macro_countries": "/economy/macro_countries",
"economy_macro_parameters": "/economy/macro_parameters",
"economy_balance": "/economy/balance",
"economy_bigmac": "/economy/bigmac",
"economy_country_codes": "/economy/country_codes",
"economy_currencies": "/economy/currencies",
"economy_debt": "/economy/debt",
"economy_events": "/economy/events",
"economy_fgdp": "/economy/fgdp",
"economy_fred": "/economy/fred",
"economy_fred_search": "/economy/fred_search",
"economy_futures": "/economy/futures",
"economy_gdp": "/economy/gdp",
"economy_glbonds": "/economy/glbonds",
"economy_indices": "/economy/indices",
"economy_overview": "/economy/overview",
"economy_perfmap": "/economy/perfmap",
"economy_performance": "/economy/performance",
"economy_revenue": "/economy/revenue",
"economy_rgdp": "/economy/rgdp",
"economy_rtps": "/economy/rtps",
"economy_search_index": "/economy/search_index",
"economy_spending": "/economy/spending",
"economy_trust": "/economy/trust",
"economy_usbonds": "/economy/usbonds",
"economy_valuation": "/economy/valuation",
"fixedincome_treasury": "/fixedincome/treasury",
"fixedincome": "/fixedincome",
"fixedincome_ycrv": "/fixedincome/ycrv"
"ta_ema": "/ta/ema"
}

9
openbb_sdk/sdk/core/openbb_core/app/static/package/news.py
View File

@@ -1,7 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import Literal, Optional
from typing import Annotated, List, Literal, Optional
import pydantic
from pydantic import validate_arguments
@@ -19,14 +18,14 @@ class CLASS_news(Container):
@validate_arguments
def globalnews(
self,
page: typing.Annotated[
page: Annotated[
pydantic.types.NonNegativeInt,
OpenBBCustomParameter(description="The page of the global news."),
] = 0,
chart: bool = False,
provider: Optional[Literal["benzinga", "fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Global News.

13
openbb_sdk/sdk/core/openbb_core/app/static/package/qa.py
View File

@@ -1,6 +1,5 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import List, Literal, Union
import openbb_provider
@@ -107,7 +106,7 @@ class CLASS_qa(Container):
threshold_start: float = 0.0,
threshold_end: float = 1.5,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Omega Ratio.
Parameters
@@ -149,7 +148,7 @@ class CLASS_qa(Container):
target: str,
window: pydantic.types.PositiveInt,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Kurtosis.
Parameters
@@ -354,7 +353,7 @@ class CLASS_qa(Container):
rfr: float = 0.0,
window: pydantic.types.PositiveInt = 252,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Sharpe Ratio.
Parameters
@@ -398,7 +397,7 @@ class CLASS_qa(Container):
window: pydantic.types.PositiveInt = 252,
adjusted: bool = False,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Sortino Ratio.
For method & terminology see: http://www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf
@@ -513,7 +512,7 @@ class CLASS_qa(Container):
target: str,
window: pydantic.types.PositiveInt,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Skewness.
Parameters
@@ -553,7 +552,7 @@ class CLASS_qa(Container):
window: pydantic.types.PositiveInt,
quantile_pct: pydantic.types.NonNegativeFloat = 0.5,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Quantile.""" # noqa: E501
inputs = filter_inputs(
data=data,

42
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py
View File

@@ -1,8 +1,7 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Annotated, List, Literal, Optional, Union
import pydantic
import pydantic.main
@@ -85,7 +84,7 @@ class CLASS_stocks(Container):
@validate_arguments
def load(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
start_date: Annotated[
@@ -103,8 +102,8 @@ class CLASS_stocks(Container):
chart: bool = False,
provider: Optional[Literal["cboe", "fmp", "polygon", "yfinance"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
r"""Load stock data for a specific ticker.
) -> CommandOutput[BaseModel]:
"""Load stock data for a specific ticker.
openbb
@@ -226,18 +225,7 @@ class CLASS_stocks(Container):
StockEOD
--------
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time."""
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -262,10 +250,10 @@ class CLASS_stocks(Container):
@validate_arguments
def news(
self,
symbols: typing.Annotated[
symbols: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
page: typing.Annotated[
page: Annotated[
int,
OpenBBCustomParameter(
description="The page of the stock news to be retrieved."
@@ -280,7 +268,7 @@ class CLASS_stocks(Container):
chart: bool = False,
provider: Optional[Literal["benzinga", "fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Get news for one or more stock tickers.
@@ -456,7 +444,7 @@ class CLASS_stocks(Container):
@validate_arguments
def multiples(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: Annotated[
@@ -466,7 +454,7 @@ class CLASS_stocks(Container):
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Get valuation multiples for a stock ticker.
@@ -671,10 +659,10 @@ class CLASS_stocks(Container):
@validate_arguments
def search(
self,
query: typing.Annotated[
query: Annotated[
str, OpenBBCustomParameter(description="The search query.")
] = "",
ticker: typing.Annotated[
ticker: Annotated[
bool,
OpenBBCustomParameter(description="Whether to search by ticker symbol."),
] = False,
@@ -756,13 +744,13 @@ class CLASS_stocks(Container):
@validate_arguments
def quote(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Load stock data for a specific ticker.
@@ -871,7 +859,7 @@ class CLASS_stocks(Container):
@validate_arguments
def info(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,

6
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py
View File

@@ -1,6 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional
from typing import Annotated, Literal, Optional
from pydantic import BaseModel, validate_arguments
@@ -17,12 +17,12 @@ class CLASS_stocks_ca(Container):
@validate_arguments
def peers(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
**kwargs,
) -> CommandOutput[BaseModel]:
"""Company peers.

9
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py
View File

@@ -1,7 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import Annotated, Literal, Optional
from typing import Annotated, List, Literal, Optional
from pydantic import validate_arguments
@@ -16,7 +15,7 @@ class CLASS_stocks_dd(Container):
@validate_arguments
def sec(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
type: Annotated[
@@ -134,8 +133,8 @@ class CLASS_stocks_dd(Container):
] = 100,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""SEC Filings.

171
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py
View File

@@ -1,7 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
import typing
from typing import Annotated, List, Literal, Optional, Union
import pydantic
@@ -38,7 +37,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def balance(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -53,8 +52,8 @@ class CLASS_stocks_fa(Container):
] = 12,
chart: bool = False,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Balance Sheet.
@@ -278,17 +277,17 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def balance_growth(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: typing.Annotated[
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Balance Sheet Statement Growth.
@@ -454,8 +453,8 @@ class CLASS_stocks_fa(Container):
] = None,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Show Dividend Calendar for a given start and end dates.
@@ -539,7 +538,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def cash(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -554,8 +553,8 @@ class CLASS_stocks_fa(Container):
] = 12,
chart: bool = False,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Cash Flow Statement.
@@ -741,17 +740,17 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def cash_growth(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: typing.Annotated[
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Cash Flow Statement Growth.
@@ -885,13 +884,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def comp(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Executive Compensation.
@@ -996,8 +995,8 @@ class CLASS_stocks_fa(Container):
] = None,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Stock Split Calendar.
@@ -1109,13 +1108,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def divs(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Historical Dividends.
@@ -1211,7 +1210,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def earning(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: Annotated[
@@ -1220,8 +1219,8 @@ class CLASS_stocks_fa(Container):
] = 50,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Earnings Calendar.
@@ -1307,13 +1306,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def emp(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Number of Employees.
@@ -1430,7 +1429,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def est(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -1439,14 +1438,14 @@ class CLASS_stocks_fa(Container):
description="Period of the data to return (quarterly or annually)."
),
] = "annually",
limit: typing.Annotated[
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 30,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Analyst Estimates.
@@ -1645,7 +1644,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def income(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -1660,8 +1659,8 @@ class CLASS_stocks_fa(Container):
] = 12,
chart: bool = False,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Income Statement.
@@ -1865,10 +1864,10 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def income_growth(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: typing.Annotated[
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
@@ -1880,8 +1879,8 @@ class CLASS_stocks_fa(Container):
] = "annually",
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Income Statement Growth.
@@ -2010,7 +2009,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def ins(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
transactionType: Annotated[
@@ -2054,8 +2053,8 @@ class CLASS_stocks_fa(Container):
] = 0,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Stock Insider Trading.
@@ -2162,10 +2161,10 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def ins_own(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
include_current_quarter: typing.Annotated[
include_current_quarter: Annotated[
bool, OpenBBCustomParameter(description="Include current quarter data.")
] = False,
date: Annotated[
@@ -2174,8 +2173,8 @@ class CLASS_stocks_fa(Container):
] = None,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Institutional Ownership.
@@ -2334,7 +2333,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def metrics(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -2349,8 +2348,8 @@ class CLASS_stocks_fa(Container):
] = 100,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Key Metrics.
@@ -2541,13 +2540,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def mgmt(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Key Executives.
@@ -2659,12 +2658,12 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def overview(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
**kwargs,
) -> CommandOutput[BaseModel]:
"""Company Overview.
@@ -2802,10 +2801,10 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def own(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
date: typing.Annotated[
date: Annotated[
datetime.date,
OpenBBCustomParameter(description="A specific date to get data for."),
],
@@ -2815,8 +2814,8 @@ class CLASS_stocks_fa(Container):
] = 0,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Stock Ownership.
@@ -2965,13 +2964,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def pt(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Price Target Consensus.
@@ -3046,13 +3045,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def pta(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Price Target.
@@ -3140,7 +3139,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def ratios(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -3155,8 +3154,8 @@ class CLASS_stocks_fa(Container):
] = 12,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Extensive set of ratios over time.
@@ -3375,7 +3374,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def revgeo(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -3390,8 +3389,8 @@ class CLASS_stocks_fa(Container):
] = "flat",
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Revenue Geographic.
@@ -3476,7 +3475,7 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def revseg(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
@@ -3491,8 +3490,8 @@ class CLASS_stocks_fa(Container):
] = "flat",
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Revenue Business Line.
@@ -3633,13 +3632,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def shrs(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Share Statistics.
@@ -3716,13 +3715,13 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def split(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Historical Stock Splits.
@@ -3812,10 +3811,10 @@ class CLASS_stocks_fa(Container):
@validate_arguments
def transcript(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
year: typing.Annotated[
year: Annotated[
int,
OpenBBCustomParameter(
description="The year of the earnings call transcript."
@@ -3829,8 +3828,8 @@ class CLASS_stocks_fa(Container):
] = 1,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
**kwargs,
) -> CommandOutput[List]:
"""Earnings Call Transcript.

6
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_options.py
View File

@@ -1,6 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional
from typing import Annotated, Literal, Optional
from pydantic import BaseModel, validate_arguments
@@ -17,12 +17,12 @@ class CLASS_stocks_options(Container):
@validate_arguments
def chains(
self,
symbol: typing.Annotated[
symbol: Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["cboe"]] = None,
**kwargs
**kwargs,
) -> CommandOutput[BaseModel]:
"""Get the complete options chain for a ticker.

53
openbb_sdk/sdk/core/openbb_core/app/static/package/ta.py
View File

@@ -1,6 +1,5 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import List, Literal, Optional, Union
import openbb_provider
@@ -27,7 +26,7 @@ class CLASS_ta(Container):
drift: pydantic.types.NonNegativeInt = 1,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Average True Range is used to measure volatility, especially volatility caused by
gaps or limit moves.
@@ -86,7 +85,7 @@ class CLASS_ta(Container):
start_date: Optional[str] = None,
end_date: Optional[str] = None,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Fibonacci Retracement Levels.
@@ -135,7 +134,7 @@ class CLASS_ta(Container):
index: str = "date",
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The On Balance Volume (OBV) is a cumulative total of the up and
down volume. When the close is higher than the previous close, the volume is added
@@ -190,7 +189,7 @@ class CLASS_ta(Container):
length: pydantic.types.PositiveInt = 14,
signal: pydantic.types.PositiveInt = 1,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Fisher Transform is a technical indicator created by John F. Ehlers
that converts prices into a Gaussian normal distribution.1 The indicator
@@ -245,7 +244,7 @@ class CLASS_ta(Container):
slow: pydantic.types.PositiveInt = 10,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Accumulation/Distribution Oscillator, also known as the Chaikin Oscillator
is essentially a momentum indicator, but of the Accumulation-Distribution line
@@ -321,7 +320,7 @@ class CLASS_ta(Container):
mamode: Literal["sma", "ema", "wma", "rma"] = "sma",
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Bollinger Bands consist of three lines. The middle band is a simple
moving average (generally 20 periods) of the typical price (TP). The upper and lower
@@ -411,7 +410,7 @@ class CLASS_ta(Container):
length: int = 50,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The zero lag exponential moving average (ZLEMA) indicator
was created by John Ehlers and Ric Way. The idea is do a
@@ -470,7 +469,7 @@ class CLASS_ta(Container):
length: int = 25,
scalar: int = 100,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The word aroon is Sanskrit for "dawn's early light." The Aroon
indicator attempts to show when a new trend is dawning. The indicator consists
@@ -532,7 +531,7 @@ class CLASS_ta(Container):
length: int = 50,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Moving Averages are used to smooth the data in an array to
help eliminate noise and identify trends. The Simple Moving Average is literally
@@ -593,7 +592,7 @@ class CLASS_ta(Container):
asint: bool = False,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Demark sequential indicator
@@ -649,7 +648,7 @@ class CLASS_ta(Container):
anchor: str = "D",
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Volume Weighted Average Price that measures the average typical price
by volume. It is typically used with intraday charts to identify general direction.
@@ -721,7 +720,7 @@ class CLASS_ta(Container):
slow: int = 26,
signal: int = 9,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Moving Average Convergence Divergence (MACD) is the difference
between two Exponential Moving Averages. The Signal line is an Exponential Moving
@@ -786,7 +785,7 @@ class CLASS_ta(Container):
length: int = 50,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Hull Moving Average solves the age old dilemma of making a moving average
more responsive to current price activity whilst maintaining curve smoothness.
@@ -843,7 +842,7 @@ class CLASS_ta(Container):
upper_length: pydantic.types.PositiveInt = 20,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Donchian Channels are three lines generated by moving average
calculations that comprise an indicator formed by upper and lower
@@ -904,7 +903,7 @@ class CLASS_ta(Container):
offset: pydantic.types.PositiveInt = 26,
lookahead: bool = False,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Ichimoku Cloud, also known as Ichimoku Kinko Hyo, is a versatile indicator that
defines support and resistance, identifies trend direction, gauges momentum and provides
@@ -955,7 +954,7 @@ class CLASS_ta(Container):
target: str = "adj_close",
period: pydantic.types.PositiveInt = 90,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Clenow Volatility Adjusted Momentum.
@@ -1004,7 +1003,7 @@ class CLASS_ta(Container):
index: str = "date",
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Accumulation/Distribution Line is similar to the On Balance
Volume (OBV), which sums the volume times +1/-1 based on whether the close is
@@ -1062,7 +1061,7 @@ class CLASS_ta(Container):
scalar: float = 100.0,
drift: int = 1,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX).
The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider
@@ -1118,7 +1117,7 @@ class CLASS_ta(Container):
length: int = 50,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
A Weighted Moving Average puts more weight on recent data and less on past data.
This is done by multiplying each bar’s price by a weighting factor. Because of its
@@ -1174,7 +1173,7 @@ class CLASS_ta(Container):
length: pydantic.types.PositiveInt = 14,
scalar: pydantic.types.PositiveFloat = 0.015,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The CCI is designed to detect beginning and ending market trends.
The range of 100 to -100 is the normal trading range. CCI values outside of this
@@ -1224,7 +1223,7 @@ class CLASS_ta(Container):
scalar: float = 100.0,
drift: int = 1,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Relative Strength Index (RSI) calculates a ratio of the
recent upward price movements to the absolute price movement. The RSI ranges
@@ -1302,7 +1301,7 @@ class CLASS_ta(Container):
slow_d_period: pydantic.types.NonNegativeInt = 3,
slow_k_period: pydantic.types.NonNegativeInt = 3,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Stochastic Oscillator measures where the close is in relation
to the recent trading range. The values range from zero to 100. %D values over 75
@@ -1379,7 +1378,7 @@ class CLASS_ta(Container):
mamode: Literal["ema", "sma", "wma", "hma", "zlma"] = "ema",
offset: pydantic.types.NonNegativeInt = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
Keltner Channels are volatility-based bands that are placed
on either side of an asset's price and can aid in determining
@@ -1438,7 +1437,7 @@ class CLASS_ta(Container):
index: str = "date",
length: pydantic.types.PositiveInt = 14,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Center of Gravity indicator, in short, is used to anticipate future price movements
and to trade on price reversals as soon as they happen. However, just like other oscillators,
@@ -1498,7 +1497,7 @@ class CLASS_ta(Container):
] = "STD",
is_crypto: bool = False,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""Calculate the realized volatility quantiles over rolling windows of time.
The model for calculating volatility is selectable.
@@ -1576,7 +1575,7 @@ class CLASS_ta(Container):
length: int = 50,
offset: int = 0,
chart: bool = False,
) -> CommandOutput[typing.List]:
) -> CommandOutput[List]:
"""
The Exponential Moving Average is a staple of technical
analysis and is used in countless technical indicators. In a Simple Moving

2
openbb_sdk/sdk/core/openbb_core/app/static/package_builder.py
View File

@@ -105,7 +105,7 @@ class PackageBuilder:
print(package_path)
with package_path.open("w", encoding="utf-8", newline="\n") as file:
file.write(module_code)
file.write(module_code.replace("typing.", ""))
class ModuleBuilder: