Fava Investor 开源项目使用教程

1. 项目目录结构及介绍

Fava Investor 的目录结构如下所示：

fava_investor/
├── .github/
│   └── workflows/
├── .gitchangelog.rc
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── MANIFEST.in
├── README.md
├── TODO.txt
├── design.md
├── requirements.txt
├── screenshot-assetalloc.png
├── screenshot.png
├── setup.py
└── ticker_util/

以下是各个目录和文件的简要介绍：

• .github/workflows/：包含 GitHub Actions 工作流文件，用于自动化项目的一些任务。
• .gitchangelog.rc：GitChangelog 形成器配置文件。
• .gitignore：Git 忽略文件列表，用于指定 Git 忽略跟踪的文件和目录。
• CHANGELOG.md：项目更新日志，记录了每个版本的重要更改和更新。
• CONTRIBUTING.md：贡献指南，指导贡献者如何为项目贡献代码和文档。
• LICENSE.md：项目使用的许可证文件，本项目采用 GPL-3.0 许可证。
• MANIFEST.in：构建项目打包文件时包含的文件列表。
• README.md：项目自述文件，介绍了项目的基本信息和如何使用。
• TODO.txt：项目待办事项列表。
• design.md：项目设计文档，可能包含架构设计和功能规划。
• requirements.txt：项目依赖文件，列出了项目运行所需的 Python 库。
• screenshot-assetalloc.png 和 screenshot.png：项目屏幕截图。
• setup.py：项目设置文件，用于打包和分发项目。
• ticker_util/：一个子模块，包含与项目相关的实用工具。

2. 项目的启动文件介绍

项目的启动主要涉及两个文件：setup.py 和 requirements.txt。

• setup.py：这个文件用于配置和打包 Python 项目。它定义了项目的名称、版本、描述、作者等信息，以及项目依赖的 Python 库。安装项目时，会使用这个文件来安装依赖。

• requirements.txt：这个文件列出了项目运行所必需的 Python 库。使用 pip install -r requirements.txt 命令可以安装这些依赖。

3. 项目的配置文件介绍

Fava Investor 的配置主要通过 Beancount 文件进行。在 Beancount 的源文件中，你需要添加如下配置来启用 Fava Investor：

2000-01-01 custom "fava-extension" "fava_investor" "{}"

这条自定义配置会在 Fava 的侧边栏中添加一个 'Investor' 链接，通过这个链接可以访问 Fava Investor 提供的各种报告和分析工具。

此外，Fava Investor 还提供了一个命令行接口 (CLI)，可以通过 investor 命令来运行不同的模块。具体的配置和使用方法可以参考项目自述文件 README.md 中的说明。