跳到主要内容

扩展概述

扩展框架允许在环境中无缝安装和移除各个组件,仅使用所需的数据和工具包扩展。

OpenBB 平台有两种主要类型的扩展:

  • 数据扩展
  • 工具包扩展

OpenBB 核心安装不包含任何工具包扩展。要从 PyPI 安装包含所有数据和工具包扩展的 OpenBB 平台:

pip install openbb[all]

从源代码安装时,从项目根目录导航到 openbb_platform 文件夹并输入:

python dev_install.py -e

这将以可编辑模式安装所有扩展,Python 接口编译在 /openbb_platform/openbb/package 中,而不是环境的 site-packages 文件夹中。下一页的表格将扩展列为核心或社区扩展。核心扩展默认安装。

数据扩展和工具包扩展之间的几个显著差异:

  • 在 OpenBB GitHub 仓库中,所有扩展都位于:

    ~/OpenBB/openbb_platform/extensions
  • 有一个额外的文件夹用于集成测试,tests 文件夹保持为空。

  • 有一个 router 文件,可以有包含额外路由器的子文件夹。

  • 实用函数不需要自己的子文件夹。

  • __init__.py 文件都是空的。

当安装或卸载扩展时,Python 接口需要重新构建静态资源,以便应用程序完全反映更改。

要调用构建过程,请从命令行输入以下行:

openbb-build

python -c "import openbb;openbb.build()"

使用 API 时不需要这样做,更改将在下次运行时反映。

覆盖范围

已安装的命令和数据提供商可在 obb.coverage 下找到。

obb.coverage
/coverage

providers
commands
command_model
command_schemas

obb.coverage.providers 是已安装提供商扩展的字典,每个都有自己的可用命令列表。

obb.coverage.commands 是命令字典,每个都有自己的数据可用提供商列表。

obb.coverage.command_model 是一个字典,其中键是命令路径,值是与该函数关联的 QueryParams 和 Data 模型的嵌套字典。