源码方式
克隆仓库后，将 financedatabase 目录放入项目路径即可使用。
pip install
方式一：pip 安装（推荐）
官方 README 与 PyPI 均建议通过 pip 安装。
| 场景 | 命令 | 说明 |
|---|---|---|
| 基础安装 | pip install financedatabase | 安装证券数据库查询功能 |
| 升级 | pip install financedatabase -U | 升级到最新版 |
| 验证安装 | python -c "import financedatabase; print(financedatabase.__version__)" | 确认可正常导入 |
环境要求：依赖 pandas（数据处理）；FinanceDatabase 返回 DataFrame，pandas 是核心依赖。
Environment
环境与依赖要求
安装前先核对 Python 与关键依赖。
| 依赖 | 说明 | 作用 |
|---|---|---|
| Python | 约 >= 3.8 | 运行环境 |
| pandas | 核心依赖 | 证券列表以 DataFrame 返回 |
建议：使用独立虚拟环境（venv/conda）隔离依赖；如遇 pandas 版本冲突，按 PyPI 约束处理。
Steps
分步安装与验证
从创建环境到运行第一个查询的完整步骤。
创建虚拟环境
python -m venv .venv并激活，隔离项目依赖。安装 financedatabase
pip install financedatabase，会自动拉取 pandas。验证导入
python -c "import financedatabase"无报错即安装成功。首次查询
import financedatabase as fd; fd.show_equities()返回股票列表。拿代码查行情
拿到证券代码后，配合 FinanceToolkit 或 yfinance 获取行情。
Other routes
方式二：源码方式与升级
除 pip 外，也可从源码使用，并可按需升级。
升级
通过 pip install financedatabase -U 升级到最新版。
配合行情源
本库只提供证券代码/元数据，行情需另配 FinanceToolkit 或 yfinance。
边界：FinanceDatabase 是库，安装后需自备行情数据源；EasyClaw 与 FinanceDatabase 无已证实集成。
Troubleshooting
常见安装问题排查
遇到安装或导入报错时，先按下面的常见原因逐项排查。
| 现象 | 可能原因 | 处理建议 |
|---|---|---|
ModuleNotFoundError: financedatabase | 未安装或装到了错误环境 | 确认当前解释器下执行 pip install financedatabase |
| pandas 版本冲突 | pandas 过旧/过新 | 按 PyPI 约束调整 pandas 版本 |
| Python 版本过低 | 低于要求版本 | 升级 Python |
| 查询返回空 | 数据源暂不可用 | 检查网络与数据源状态 |
FAQ
安装常见问题
FinanceDatabase 的包名是什么？
PyPI 包名是 financedatabase（安装命令为 pip install financedatabase）；GitHub 仓库名为 FinanceDatabase。
安装需要多少 Python 版本？
约 Python >= 3.8，建议使用较新版本。
FinanceDatabase 依赖哪些库？
核心依赖 pandas（证券列表以 DataFrame 返回）；行情需另配 FinanceToolkit 或 yfinance。
能在 EasyClaw 里一键安装 FinanceDatabase 吗？
无已证实集成。FinanceDatabase 需通过 pip 自行安装；EasyClaw 提供的是独立的金融数据/量化研究 Skill。