Obsidian本地备份项目启动与配置教程

1. 项目的目录结构及介绍

obsidian-local-backup 项目是一个用于备份Obsidian笔记的工具。以下是项目的目录结构及文件介绍：

obsidian-local-backup/
├── backup/             # 存储备份文件的目录
├── .env.example        # 配置文件示例
├── package-lock.json   # 依赖锁定文件
├── package.json        # 项目依赖和脚本
├── README.md           # 项目说明文件
└── src/                # 源代码目录
    ├── backup.py       # 备份脚本文件
    ├── __init__.py     # 初始化文件
    └── utils.py        # 工具函数文件

• backup/: 备份文件存储的目录，所有备份的笔记文件都会被存放于此。
• .env.example: 配置文件示例，展示了如何配置环境变量。
• package-lock.json: 项目的依赖锁定文件，确保依赖的版本一致。
• package.json: 包含了项目的依赖和运行脚本。
• README.md: 项目说明文件，提供了项目的基本信息和如何使用。
• src/: 源代码目录，包含了项目的所有脚本和函数。

2. 项目的启动文件介绍

项目的启动文件为 src/backup.py，该脚本负责执行备份操作。以下是启动文件的简要介绍：

# backup.py

# 导入必要的模块
from utils import backup笔记

def main():
    # 执行备份操作
    backup笔记()

if __name__ == "__main__":
    main()

要启动项目，你需要在项目根目录下运行以下命令：

python src/backup.py

3. 项目的配置文件介绍

项目的配置文件为 .env.example，你需要根据实际情况对其进行修改。以下是配置文件的介绍：

# .env.example

# Obsidian笔记库的位置
OBSIDIAN_FOLDER_PATH="/path/to/your/obsidian/folder"

# 备份存储的位置
BACKUP_FOLDER_PATH="/path/to/your/backup/folder"

你需要将 OBSIDIAN_FOLDER_PATH 和 BACKUP_FOLDER_PATH 替换为你的Obsidian笔记库和备份文件夹的实际路径。项目在运行时会读取这些环境变量以确定备份的位置。

请注意，.env.example 文件仅用于示例，实际使用时你应该创建一个名为 .env 的文件，并将你的配置信息放入该文件中。不要将 .env 文件提交到版本控制系统中，因为它可能包含敏感信息。