jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 00:12:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Excel docs update (#6504)

Browse Source 
* update xl docs

* update xl files
This commit is contained in:
montezdesousa
2024-06-14 23:22:18 +01:00
committed by GitHub
parent a11489614d
commit b7088a2107
4 changed files with 11892 additions and 7915 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3811
website/content/excel/functions.json vendored
View File

File diff suppressed because it is too large Load Diff

15729
website/content/excel/openapi.json vendored
View File

File diff suppressed because it is too large Load Diff

173
website/content/excel/openbb-functions.json vendored Normal file
View File

@@ -0,0 +1,173 @@
{
"CURRENCY.PRICE.HISTORICAL": {
"providers": [
"fmp"
]
},
"CURRENCY.SNAPSHOTS": {
"providers": [
"fmp"
]
},
"ECONOMY.CALENDAR": {
"providers": [
"tradingeconomics"
]
},
"EQUITY.COMPARE.PEERS": {
"providers": [
"fmp"
]
},
"EQUITY.ESTIMATES.CONSENSUS": {
"providers": [
"fmp"
]
},
"EQUITY.ESTIMATES.HISTORICAL": {
"providers": [
"fmp"
]
},
"EQUITY.ESTIMATES.PRICE_TARGET": {
"providers": [
"benzinga",
"fmp"
]
},
"EQUITY.FUNDAMENTAL.BALANCE": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.CASH": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.DIVIDENDS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.FILINGS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.HISTORICAL_EPS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.INCOME": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.MANAGEMENT": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.METRICS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.OVERVIEW": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.RATIOS": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT": {
"providers": [
"fmp"
]
},
"EQUITY.FUNDAMENTAL.TRANSCRIPT": {
"providers": [
"fmp"
]
},
"EQUITY.OWNERSHIP.INSIDER_TRADING": {
"providers": [
"fmp"
]
},
"EQUITY.OWNERSHIP.INSTITUTIONAL": {
"providers": [
"fmp"
]
},
"EQUITY.OWNERSHIP.MAJOR_HOLDERS": {
"providers": [
"fmp"
]
},
"EQUITY.OWNERSHIP.SHARE_STATISTICS": {
"providers": [
"fmp"
]
},
"EQUITY.PRICE.HISTORICAL": {
"providers": [
"fmp"
]
},
"EQUITY.PRICE.PERFORMANCE": {
"providers": [
"fmp"
]
},
"EQUITY.PRICE.QUOTE": {
"providers": [
"fmp"
]
},
"EQUITY.PROFILE": {
"providers": [
"fmp"
]
},
"ETF.HOLDINGS": {
"providers": [
"intrinio"
]
},
"ETF.INFO": {
"providers": [
"intrinio"
]
},
"INDEX.MARKET": {
"providers": [
"fmp"
]
},
"NEWS.COMPANY": {
"providers": [
"benzinga"
]
},
"NEWS.WORLD": {
"providers": [
"benzinga"
]
}
}

94
website/generate_excel_markdown.py
View File

@@ -12,11 +12,13 @@ import requests
WEBSITE_PATH = Path(__file__).parent.absolute()
CONTENT_PATH = WEBSITE_PATH / "content"
XL_FUNCS_PATH = CONTENT_PATH / "excel" / "functions.json"
XL_OPENBB_FUNCS_PATH = CONTENT_PATH / "excel" / "openbb-functions.json"
XL_PLATFORM_PATH = CONTENT_PATH / "excel" / "openapi.json"
SEO_METADATA_PATH = WEBSITE_PATH / "metadata" / "platform_v4_seo_metadata.json"
# URLs: the platform url should match the backend being used by excel.openbb.co
XL_FUNCS_URL = "https://excel.openbb.co/assets/functions.json"
XL_OPENBB_FUNCS_URL = "https://excel.openbb.co/assets/openbb-functions.json"
XL_PLATFORM_URL = "https://sdk.openbb.co/openapi.json"
@@ -46,6 +48,7 @@ class CommandLib:
def __init__(self):
self.xl_funcs = self.read_xl_funcs()
self.xl_openbb_funcs = self.read_xl_openbb_funcs()
self.openapi = self.read_openapi()
self.seo_metadata = self.read_seo_metadata()
@@ -56,6 +59,13 @@ class CommandLib:
with open(XL_FUNCS_PATH, "w") as f:
json.dump(r.json(), f, indent=2)
@staticmethod
def fetch_xl_openbb_funcs():
"""Fetch the openbb version of excel functions."""
r = requests.get(XL_OPENBB_FUNCS_URL, timeout=10)
with open(XL_OPENBB_FUNCS_PATH, "w") as f:
json.dump(r.json(), f, indent=2)
@staticmethod
def fetch_openapi():
"""Fetch the openapi.json."""
@@ -89,6 +99,12 @@ class CommandLib:
for func in funcs["functions"]
}
def read_xl_openbb_funcs(self) -> Dict[str, Any]:
"""Read the Excel openbb functions file."""
with open(XL_OPENBB_FUNCS_PATH) as f:
funcs = json.load(f)
return funcs
def read_openapi(self) -> dict:
"""Get the openapi.json."""
with open(XL_PLATFORM_PATH) as f:
@@ -148,17 +164,39 @@ class CommandLib:
)
):
models = self._traverse(["properties", "results", "anyOf"], inner_schema)[0]
if models.get("type") == "array":
models = models["items"]
models = (
models["items"].get("oneOf", [models["items"]])
if models.get("type") == "array"
else [models]
)
d = {}
for k, v in self._traverse(["discriminator", "mapping"], models).items():
model_schema = self._traverse(v.split("/"), self.openapi, ["#"])
d[k] = {
name: {"description": info.get("description", "").replace("\n", "")}
for name, info in model_schema["properties"].items()
}
return d
# Get the available providers from the provider parameter enum
parameters = self._traverse(
[
"paths",
self.API_PREFIX + cmd,
"get",
"parameters",
],
self.openapi,
)
providers = []
for p in parameters:
if p.get("name") == "provider":
providers = p.get("schema", {}).get("enum", [])
if providers:
d = {}
for i, model in enumerate(models):
ref = model.get("$ref", "")
model_schema = self._traverse(ref.split("/"), self.openapi, ["#"])
provider = providers[i]
d[provider] = {
name: {
"description": info.get("description", "").replace("\n", "")
}
for name, info in model_schema["properties"].items()
}
return d
return {}
def _get_examples(
@@ -210,6 +248,7 @@ class CommandLib:
data = self._get_data(cmd)
return_ = self.xl_funcs[cmd].get("result", {}).get("dimensionality", "")
examples = self._get_examples(cmd, parameters)
providers = self.xl_openbb_funcs.get(function, {}).get("providers", [])
return {
"name": name,
"description": description,
@@ -219,6 +258,7 @@ class CommandLib:
"data": data,
"return": return_,
"examples": examples,
"providers": providers,
}
@@ -311,20 +351,25 @@ class Editor:
def get_data() -> str:
if data_schema := cmd_info["data"]:
data = "import Tabs from '@theme/Tabs';\n"
data += "import TabItem from '@theme/TabItem';\n\n"
data += "## Data\n\n"
data += "<Tabs>\n"
for provider, fields in data_schema.items():
data += f"<TabItem value='{provider}'>\n\n"
data += "| Name | Description |\n"
data += "| ---- | ----------- |\n"
for name, info in fields.items():
description = info["description"]
data += f"| {name} | {description} |\n"
data += "</TabItem>\n"
data += "</Tabs>\n"
return data
providers = cmd_info["providers"]
filtered_data_schema = {
k: v for k, v in data_schema.items() if k in providers
}
if filtered_data_schema:
data = "import Tabs from '@theme/Tabs';\n"
data += "import TabItem from '@theme/TabItem';\n\n"
data += "## Data\n\n"
data += "<Tabs>\n"
for provider, fields in filtered_data_schema.items():
data += f"<TabItem value='{provider}'>\n\n"
data += "| Name | Description |\n"
data += "| ---- | ----------- |\n"
for name, info in fields.items():
description = info["description"]
data += f"| {name} | {description} |\n"
data += "</TabItem>\n"
data += "</Tabs>\n"
return data
return ""
def get_examples() -> str:
@@ -512,6 +557,7 @@ if __name__ == "__main__":
pass
else:
CommandLib.fetch_xl_funcs()
CommandLib.fetch_xl_openbb_funcs()
CommandLib.fetch_openapi()
Editor(