Obsidian Readwise 项目启动与配置教程

1. 项目目录结构及介绍

obsidian-readwise 项目的主要目录结构如下：

obsidian-readwise/
├── .github/                # GitHub 仓库相关文件
│   └── workflows/          # GitHub Actions 工作流
├── .vscode/                # VSCode 项目配置
├── assets/                 # 资源文件目录
├── bin/                    # 执行文件目录
├── data/                   # 数据存储目录
├── docs/                   # 文档目录
├── examples/               # 示例文件目录
├── obsidian-readwise/       # 主程序目录
│   ├── __init__.py         # 初始化文件
│   ├── ...                 # 其他 Python 模块文件
│   └── main.py             # 主程序入口
├── requirements.txt        # 项目依赖文件
├── setup.py                # 项目设置文件
└── test/                   # 测试文件目录

主要目录说明：

• .github/: 存放 GitHub Actions 工作流和相关配置文件。
• .vscode/: 存放 Visual Studio Code 项目的配置文件。
• assets/: 存放项目所需的资源文件，如图片、样式表等。
• bin/: 存放可执行文件或脚本。
• data/: 存放项目运行过程中生成的数据文件。
• docs/: 存放项目文档。
• examples/: 存放示例文件，用于展示项目功能。
• obsidian-readwise/: 主程序目录，包含项目的核心代码。
• requirements.txt: 记录项目依赖的 Python 包。
• setup.py: 项目设置文件，用于安装 Python 包。
• test/: 存放测试代码。

2. 项目的启动文件介绍

项目的启动文件为 obsidian-readwise/main.py。该文件是程序的入口点，主要完成以下功能：

• 导入必要的模块和库。
• 初始化配置。
• 设置日志记录。
• 主程序逻辑。

启动项目时，可以在命令行中运行以下命令：

python obsidian-readwise/main.py

3. 项目的配置文件介绍

项目的配置文件为 config.py，位于 obsidian-readwise/ 目录下。该文件包含项目运行所需的各种配置信息，如：

• 数据库连接信息。
• API 密钥。
• 日志配置。
• 其他自定义配置。

在 config.py 文件中，你可以根据实际情况修改配置信息，例如：

# 数据库配置
DATABASE_URI = 'sqlite:///data/database.db'

# API 密钥
API_KEY = 'your_api_key'

# 日志配置
LOG_LEVEL = 'INFO'
LOG_FILE = 'logs/app.log'

确保配置正确后，项目就可以根据这些配置信息正常运行了。