有道云笔记导出工具安装与使用指南

有道云笔记导出工具安装与使用指南

youdaonote-pull📝 一个一键导出 / 备份「有道云笔记」所有笔记的 Python 脚本。 A Python script to export/backup all the notes of the "Youdao Note".项目地址:https://gitcode.com/gh_mirrors/yo/youdaonote-pull

一、项目目录结构及介绍

当你通过 git clone https://github.com/DeppWang/youdaonote-pull.git 命令克隆该项目至本地后，你会看到以下的目录结构：

youdaonote-pull/
├── LICENSE.md         # 开源协议许可证文件
├── README.md          # 项目说明文档
├── config.json        # 主要配置文件，用于存放账户信息和其他配置项
├── cookies.json       # 存储有道云笔记登录状态的文件
├── pull.py            # 主要执行文件，Python脚本用于导出有道云笔记的所有笔记
├── requirements.txt   # 项目依赖库列表
└── .gitignore         # Git忽略规则文件，定义不需要被版本控制管理的文件或目录

目录详解:

• LICENSE.md: 文件中包含了MIT开源许可协议，说明了项目开源授权方式。
• README.md: 提供了关于项目功能、使用方法以及一些额外说明的信息文档。
• config.json: JSON格式的配置文件，主要用于存放用户的有道云笔记账号信息以及其他必要的设置选项。
• cookies.json: 这个文件用于存储用户的登录状态，以便于后续操作无需重复登录过程。
• pull.py: 是整个项目的执行核心，它负责读取配置，处理数据并实现最终的笔记导出任务。
• requirements.txt: 列出了此项目所需的所有第三方Python包，可以使用pip install -r requirements.txt命令一次性安装全部依赖。

二、项目的启动文件介绍

pull.py 是该项目的核心执行文件。该文件通过调用requests等库来访问有道云笔记API，从而获取用户的笔记数据，并根据配置进行导出。

• 文件结构: 包括导入必要模块、定义函数、读取配置文件、登录验证、数据抓取和处理逻辑。
• 主要功能:
  • 登录有道云笔记网站并保存登录状态。
  • 获取用户的笔记列表。
  • 下载笔记及其附件。
  • 将笔记转换为Markdown或其他指定格式。

为了顺利执行 pull.py ，确保已经正确设置了 config.json 和系统环境变量。

三、项目的配置文件介绍

config.json 是项目的配置中心，用于提供必需的参数以完成笔记导出操作。

配置文件示例:

{
    "email": "example@domain.com",
    "password": "your-password",
    // 其他可能的选项包括导出路径、图片存储位置等
}

• 邮箱地址(email) 和 密码(password) : 用于登录有道云笔记。
• 导出路径 : 指定下载后的笔记保存在本地的哪个目录下，默认通常为当前工作目录下的特定子目录。
• 图片存储位置 : 若笔记中含有图片，则应设定图片的本地存储位置，或是选择上传至其他图床服务。

务必保证这些配置正确无误，以免在执行过程中遇到权限或连接错误。修改 config.json 后，重新运行程序即可应用新的配置设置。

以上介绍了如何理解项目结构、怎样准备并启动项目，以及如何调整配置以适应不同的需求场景。遵循这份指南，你可以成功地利用这个脚本来备份自己的有道云笔记资料。

youdaonote-pull📝 一个一键导出 / 备份「有道云笔记」所有笔记的 Python 脚本。 A Python script to export/backup all the notes of the "Youdao Note".项目地址:https://gitcode.com/gh_mirrors/yo/youdaonote-pull