Robinhood-for-Google-Finance 使用手册
本指南将帮助您了解如何使用 Robinhood-for-Google-Finance
这个开源项目,它是一个用于将Robinhood交易导出到CSV文件的Python脚本。此工具对于希望在Google Finance中便捷跟踪自己交易历史的投资者尤为有用。
1. 项目目录结构及介绍
该项目的目录结构简洁明了,下面是主要组成部分的概述:
Robinhood-for-Google-Finance/
|-- src/
| |-- robinhood.py # 核心模块,处理与Robinhood API交互逻辑
| |-- google_finance.py # 负责数据导入到Google Finance的逻辑
|-- requirements.txt # 项目依赖库列表
|-- export_trades.py # 主启动脚本,调用核心模块进行交易导出
|-- README.md # 项目简介和快速指引
|-- LICENSE # 开源许可协议(MIT)
- src: 包含所有核心功能代码,分为处理Robinhood交易数据的
robinhood.py
和与Google Finance交互的google_finance.py
。 - requirements.txt: 列出了运行项目所需的Python包及其版本。
- export_trades.py: 用户应从这个脚本开始执行,以导出交易记录到CSV文件。
- README.md: 提供了关于项目的基本信息和快速入门指导。
- LICENSE: MIT许可证文本,说明了软件的授权条件和使用权利。
2. 项目的启动文件介绍
export_trades.py
这是项目的主入口点,用户通过运行这个脚本来完成交易记录的导出过程。它会调用src
目录下的其他模块来完成认证、获取数据以及导出操作。基本使用步骤通常包括设置必要的环境变量或配置,然后执行脚本,示例命令如下:
python export_trades.py
请注意,在实际使用前,需要确保你已经配置好与Robinhood账户相关的访问令牌或遵循项目内提供的认证流程。
3. 项目的配置文件介绍
虽然本项目没有直接提供一个典型的配置文件,但关键配置信息通常通过环境变量形式管理。为了能够连接到你的Robinhood账户并导出数据,你需要设置以下环境变量:
RH_USERNAME
: Robinhood账户的用户名。RH_PASSWORD
: Robinhood账户的密码。RH_MFA_CODE
: 如果你的账户启用了双因素认证,需要提供MFA验证码。RH_TOTP_SECRET
: 可选,如果你使用的是基于时间的一次性密码(TOTP),则需提供密钥。GOOGLE_SHEET_NAME
: 将数据导入Google Finance时,目标工作表的名称。
这些环境变量的设置可以通过终端命令或者在开发环境中设定,具体方法依据您的操作系统和个人偏好而定。
以上就是对 Robinhood-for-Google-Finance
项目的基本介绍。记得在使用过程中阅读项目的最新文档和更新日志,以获取最佳实践和任何可能的变化。