今すぐお試しください!

製品の詳細CData Python Connector for Confluence を確認して、無償評価版をダウンロード:

今すぐダウンロード

Dash を使って、Confluence Data に連携するウェブアプリケーションを開発

CData Python Connector for Confluence を使って、Confluence にデータ連携するPython ウェブアプリケーションを開発できます。pandas とDash を使って作成してみます。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Confluence を使うことで、pandas モジュールとDash フレームワークでConfluence にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Confluence に連携して、Confluence data をビジュアライズするシンプルなウエブアプリを作ります。

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムConfluence data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Confluence に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Confluence 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Confluence Data への接続

Confluence data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します(Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。):

  • User: Confluence サーバーに認証するユーザー名。
  • APIToken: 認証するユーザーに紐付けられたAPI Token。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

  • User: Confluence Instance に接続するユーザー名。
  • Password: Confluence Instance に接続するユーザーのパスワード。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

以下の手順に従い、必要なモジュールをインストールし、Python オブジェクト経由でConfluence にアクセスします。

必要なモジュールのインストール

pip で必要なモジュールおよびフレームワークをインストールします:

pip install pandas
pip install dash
pip install dash-daq

Python でConfluence Data をビジュアライズ

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

まず、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 data との接続を確立します。

cnxn = mod.connect("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")

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 data をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

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(title='Confluence Pages Data', barmode='stack')
		})
], className="container")

アプリをセットアップして、実行n

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。Python コードの最後はこのようです。

if __name__ == '__main__':
    app.run_server(debug=True)

では、Python でウェブアプリを稼働させて、ブラウザでConfluence data を見てみましょう。

python confluence-dash.py

製品の無償トライアル情報

Confluence Python Connector の30日の無償トライアル をぜひダウンロードして、Confluence data への接続を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(title='Confluence Pages Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)
 
 
ダウンロード