各製品の資料を入手。
詳細はこちら →
製品をチェック
Python のDash ライブラリを使って、Confluence のデータ に連携するウェブアプリケーションを開発する方法
CData Python Connector を使って、Confluence にデータ連携するPython ウェブアプリケーションを開発できます。pandas とDash を使って作成してみます。
最終更新日：2023-09-23
この記事で実現できるConfluence 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Confluence を使うことで、pandas モジュールとDash フレームワークでConfluence にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Confluence に連携して、Confluence のデータ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Confluence をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Dash をはじめとする多様なデータ分析・BI ツールにConfluence のデータを連携
- ノーコードでの手軽な接続設定
必要なモジュールのインストール
まずは、pip で必要なモジュールおよびフレームワークをインストールします：
pip install pandas pip install dash pip install dash-daq
Python でConfluence のデータを可視化
必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。
まず、CData Connector を含むモジュールをインポートします：
import os import dash import dash_core_components as dcc import dash_html_components as html import pandas as pd import cdata.confluence as mod import plotly.graph_objs as go
接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData Confluence Connector からConfluence のデータ との接続を確立します。
cnxn = mod.connect("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
Confluence 接続プロパティの取得・設定方法
任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。
Confluence への認証
Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。
API トークン - Confluence Cloud アカウント
トークンの取得
アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。
トークンを使用する認証
Cloud アカウントへの認証を行うには、以下を入力します。
- AuthScheme：APIToken に設定。
- User：Confluence サーバーに認証する際に使用されるユーザー。
- APIToken：現在認証されているユーザーに紐づくAPI トークン。
- Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
Basic 認証 - Confluence Server インスタンス
Server インスタンスへの認証を行うには、以下のように指定します。
- AuthScheme：Basic に設定。
- User：Confluence インスタンスに認証する際に使用されるユーザー。
- Password：Confluence サーバーに認証する際に使われるパスワード。
- Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
Confluence にクエリを実行
read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。
df = pd.read_sql("""SELECT Key, Name FROM Pages WHERE Id = '10000'""", cnxn)
ウェブアプリケーションの設定
DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。
app_name = 'dash-confluenceedataplot' external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css'] app = dash.Dash(__name__, external_stylesheets=external_stylesheets) app.title = 'CData + Dash'
Layout 設定
次に、Confluence のデータ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。
trace = go.Bar(x=df.Key, y=df.Name, name='Key')
app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
dcc.Graph(
id='example-graph',
figure={
'data': [trace],
'layout':
go.Layout(alt='Confluence Pages Data', barmode='stack')
})
], className="container")
アプリをセットアップして実行
接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。
if __name__ == '__main__':
app.run_server(debug=True)
最後に、Python でウェブアプリを起動してブラウザでConfluence のデータ を見てみましょう。
python confluence-dash.py
ちゃんとデータが表示できてますね！
おわりに
Confluence Python Connector の30日の無償トライアル をぜひダウンロードして、Confluence のデータ への接続をPython アプリやスクリプトから簡単に作成してみてください。
import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.confluence as mod
import plotly.graph_objs as go
cnxn = mod.connect("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
df = pd.read_sql("SELECT Key, Name FROM Pages WHERE Id = '10000'", cnxn)
app_name = 'dash-confluencedataplot'
external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']
app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Key, y=df.Name, name='Key')
app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
dcc.Graph(
id='example-graph',
figure={
'data': [trace],
'layout':
go.Layout(alt='Confluence Pages Data', barmode='stack')
})
], className="container")
if __name__ == '__main__':
app.run_server(debug=True)
関連コンテンツ
