confluenceDumpWithPython

使用 Python 进行 Confluence 转储

使用 Python（请求）以 HTML 和 RST 格式转储 Confluence 页面，包括嵌入的图片和附件。对下载文件的引用将更新为其本地相对路径。

描述

尽管如此，重构只需要 2 个文件并接受命令行参数：

• myModules.py ：包含所有必需的功能。
• confluenceDumpWithPython.py ：与以下命令行参数一起使用的脚本：
  • -m, --mode ：导出模式， single ， space ， bylabel ， pageprops （必需）。
    • 注意：到目前为止仅实现了single 、 pageprops和space 。
  • -S, --site ：Atlassian 站点（必需）。
  • -s, --space ：空格键（如果需要）。
  • -p, --page ：页面 ID（如果需要）。
  • -l, --label ：页面标签（如果需要）。
  • -x, --sphinx ： _images和_static文件夹放置在导出文件夹的根目录下，而不是与导出的 HTML 文件放在一起。
  • --notags ：不将标签指令添加到第一个文件中（当不使用sphinx-tags插件时）。
• updatePageLinks.py ：更新目前已下载的本地文件的在线 Confluence 链接。
  • --folder ：包含要更新的文件的文件夹。
  • --test ：它不会覆盖原始 .rst 文件，而是创建以zout_作为前缀的更新文件。
• getPageEditorVersion.py ：从单个页面或空间中的所有页面获取编辑器版本。
  • --site ：Atlassian 站点（必需）。
  • --page : 页面 ID (或者/或者)
  • --space : 空格键（任一/或）

对于 CSS 样式，它使用 Confluence 中的confluence.css ，可以通过使用 https://jira.atlassian.com/browse/CONFSERVER-40907 中描述的解决方法获得。 Confluence UI HTML 导出中包含的site.css文件并不像上面的文件那么完整。

文件夹和文件结构：

• 默认输出文件夹是与脚本位于同一路径下的output/ 。
• 将在输出文件夹下创建一个包含空间名称、页面属性报告页面、单页面名称或页面标签名称的文件夹。
• 默认情况下， _images/和_static/文件夹将放置在 page|space|pageprops|label 文件夹中。
  • --sphinx命令行选项会将这些文件夹直接放在输出文件夹下
• 文件styles/confluence.css将被复制到定义的_static/中

它的作用

• 利用 Confluence Cloud API
• 将 Confluence 元数据（例如页面 ID 和页面标签）放入 HTML 标头和 RST 字段中。
• beautifulsoup用于解析HTML以获取和更新内容，即。将远程链接更改为本地链接。
• 下载每个页面、所有附件、表情符号和嵌入文件。

要求

• 声明系统变量：
  • atlassianAPIToken
  • atlassianUserEmail

依赖关系

• 蟒蛇3
  • 要求
  • 美丽汤4
  • 枕头（手柄图片）
  • pandoc 和 pypandoc（转换为 RST）
  • 关于

安装中

• 克隆仓库。
• 安装依赖项。
• 声明 Atlassian API 令牌的系统变量。

执行程序

• 如何根据 ID 下载单个页面。

 confluenceDumpWithPython.py -m single -S  -p  [
] [--sphinx]

• 如何下载页面属性和所有包含的页面。

 confluenceDumpWithPython.py -m pageprops -S  -p  [
] [--sphinx]

• 如何下载整个空间。

 confluenceDumpWithPython.py -m space -S  -s  [
]

帮助

除了以下情况外，没有特别建议：

• 确保您的 Atlassian API 令牌有效。
• Cloud Atlassian API 的用户名是电子邮件地址。

作者

贡献者姓名和联系信息

@dernorberto

改进

• 添加基于页面标签的导出。
• 添加相应页面的下载链接。
• 将下载页面的所有链接更新到本地副本。
• 将父页面和页面标签添加到标题。
• 创建页面索引以用作目录。
• 创建页面布局以显示目录+文章。
• 如果不存在，请将styles/site.css复制到output/styles/中。
• 允许与 Confluence Server 一起使用。

问题

• 它不喜欢很长的附件文件，您需要在转储之前在 Confluence 中重命名它们。
• 之前从 Confluence Server 迁移的页面可能存在旧表情符号问题。最好的方法是将页面转换为新编辑器，这将替换丢失的表情符号。

版本历史

• 1.4
  • 重构为更简单的文件设置（ confluenceDumpWithPython.py和myModules.py ）
• 1.3
  • 添加了空间导出（平面文件夹结构）
• 1.2
  • 添加了更好的 HTML 页眉和页脚。
  • 向 HTML 标题添加了页面标签。
  • 改进了输出文件夹参数逻辑。
• 1.1
  • 添加了页面属性转储和其他较小的东西
• 1.0
  • 初始版本

包含以前版本脚本的legacy/文件夹

文件的目的：

1. confluenceExportHTMLrequestsByLabel.py ：根据一个（或多个）页面标签下载一组页面。
2. confluenceExportHTMLrequestsSingle.py ：通过提供页面 ID 作为参数来下载单个页面。
3. confluenceExportHTMLrequestsPagePropertiesReport.py ：通过提供页面 ID 作为参数来下载页面属性和报告中的所有页面。
4. confluenceExportHTMLrequestsPagesInSpace.py ：从空间下载所有页面。

执照

该项目已根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE.txt 文件

致谢