confluencePython でダンプ

Python を使用した Confluence ダンプ

Python (リクエスト) を使用して、埋め込み画像や添付ファイルを含む Confluence ページを HTML および RST 形式でダンプします。ダウンロードされたファイルへの参照は、ローカルの相対パスに更新されます。

説明

それにもかかわらず、リファクタリングに必要なファイルは 2 つだけで、コマンドライン引数を受け入れます。

• myModules.py : 必要な関数がすべて含まれています。
• confluenceDumpWithPython.py : 次のコマンド ライン引数で使用するスクリプト:
  • -m, --mode : エクスポート モード、 single 、 space 、 bylabel 、 pageprops (必須)。
    • 注: これまでのところ、 single 、 pageprops 、およびspaceのみが実装されています。
  • -S, --site : アトラシアン サイト (必須)。
  • -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 : アトラシアン サイト (必須)。
  • --page : ページ ID (いずれかまたは両方)
  • --space : スペースキー (いずれか)

CSS スタイルには、https://jira.atlassian.com/browse/CONFSERVER-40907 で説明されている回避策を使用して取得できる Confluence のconfluence.cssが使用されます。 Confluence UI HTML エクスポートに含まれるsite.cssファイルは、上記のものほど完全ではありません。

フォルダーとファイルの構造:

• デフォルトの出力フォルダーは、スクリプトと同じパスにあるoutput/です。
• 出力フォルダーの下に、スペース名、ページ プロパティ レポート ページ、単一ページ名、またはページ ラベル名のフォルダーが作成されます。
• デフォルトでは、 _images/フォルダーと_static/フォルダーは page|space|pageprops|label フォルダーに配置されます。
  • --sphinxコマンド ライン オプションは、これらのフォルダーを出力フォルダーの直下に置きます。
• ファイルstyles/confluence.css定義された_static/にコピーされます。

何をするのか

• Confluence Cloud API を活用
• ページ ID やページ ラベルなどの Confluence メタ データを HTML ヘッダーと RST フィールドに配置します。
• beautifulsoup は、HTML を解析してコンテンツを取得および更新するために使用されます。リモートリンクをローカルリンクに変更します。
• すべてのページ、すべての添付ファイル、絵文字、埋め込みファイルをダウンロードします。

要件

• システム変数を宣言します。
  • atlassianAPIToken
  • atlassianUserEmail

依存関係

• Python3
  • リクエスト
  • 美しいスープ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 のユーザー名は電子メール アドレスです。

著者

寄稿者の名前と連絡先情報

@デルノルベルト

改善点

• ページラベルに基づいてエクスポートを追加します。
• 対応するページのダウンロードへのリンクを追加します。
• ダウンロードしたページからローカル コピーへのすべてのリンクを更新します。
• 親ページとページラベルをヘッダーに追加します。
• 目次として使用するページのインデックスを作成します。
• 目次 + 記事を表示するページ レイアウトを作成します。
• 存在しない場合は、 styles/site.cssをoutput/styles/にコピーします。
• Confluence Server での使用を許可します。

問題

• 非常に長い添付ファイルは好まれないため、ダンプの前に Confluence で添付ファイルの名前を変更する必要があります。
• 以前に Confluence Server から移行されたページには、古い絵文字に関する問題が発生する可能性があります。最善の方法は、ページを新しいエディタに変換して、不足している絵文字を置き換えることです。

バージョン履歴

• 1.4
  • よりシンプルなファイル設定へのリファクタリング ( confluenceDumpWithPython.pyおよびmyModules.py )
• 1.3
  • スペースエクスポート（フラットフォルダー構造）を追加しました
• 1.2
  • より適切な HTML ヘッダーとフッターを追加しました。
  • HTMLヘッダーにページラベルを追加しました。
  • 出力フォルダーの引数ロジックが改善されました。
• 1.1
  • Papge プロパティ ダンプとその他の小さなものを追加しました
• 1.0
  • 初期リリース

以前のバージョンのスクリプトが含まれるlegacy/フォルダー

ファイルの目的:

1. confluenceExportHTMLrequestsByLabel.py : 1 つ (または複数) のページ ラベルに基づいてページのセットをダウンロードします。
2. confluenceExportHTMLrequestsSingle.py : ページ ID を引数として指定して、単一のページをダウンロードします。
3. confluenceExportHTMLrequestsPagePropertiesReport.py : ページ ID を引数として指定して、ページ プロパティとレポート内のすべてのページをダウンロードします。
4. confluenceExportHTMLrequestsPagesInSpace.py : スペースからすべてのページをダウンロードします。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE.txt ファイルを参照してください。

謝辞