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 文件

致謝