Confluence Dumper 使用教程

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

Confluence Dumper 项目的目录结构如下：

confluence-dumper/
├── confluence_dumper.py
├── requirements.txt
├── settings_sample.py
├── template.html
├── utils.py
├── README.rst
├── LICENSE.md
└── .gitignore

各文件和目录的介绍如下：

• confluence_dumper.py: 项目的主启动文件，用于执行导出操作。
• requirements.txt: 项目依赖文件，列出了运行项目所需的 Python 包。
• settings_sample.py: 配置文件的示例，用户需要根据实际情况进行修改。
• template.html: 导出页面时使用的 HTML 模板。
• utils.py: 包含一些辅助功能的 Python 文件。
• README.rst: 项目的说明文档。
• LICENSE.md: 项目的许可证文件。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件是 confluence_dumper.py。该文件包含了主要的逻辑和功能，用于通过 Confluence API 递归地导出空间和页面。

3. 项目的配置文件介绍

项目的配置文件是 settings_sample.py。用户需要将其复制为 settings.py 并根据实际情况进行个性化配置。配置文件中包含了与 Confluence 实例相关的设置，例如 API 地址、认证信息等。

# settings.py 示例
CONFLUENCE_URL = 'https://your-confluence-instance.com'
USERNAME = 'your-username'
PASSWORD = 'your-password'
SPACE_KEY = 'your-space-key'

用户需要根据实际的 Confluence 实例信息修改这些配置项。

---

以上是 Confluence Dumper 项目的使用教程，希望对您有所帮助。