各製品の資料を入手。
詳細はこちら →
製品をチェック
Python pandas を使ってConfluence のデータを可視化・分析する方法
CData Python Connector を使えば、Python でConfluence をpandas などのライブラリで呼び出してデータ分析や可視化を実行できます。
最終更新日：2023-09-23
この記事で実現できるConfluence 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Python エコシステムには多くのライブラリがあり、開発やデータ分析を行う際には必須と言っていいライブラリも多く存在します。CData Python Connector for Confluence は、pandas、Matplotlib、SQLAlchemy から使用することで Confluence にデータ連携するPython アプリケーションを構築したり、Confluence のデータの可視化を実現します。本記事では、pandas、SQLAlchemy、およびMatplotlib のビルトイン機能でConfluence にリアルタイムアクセスし、クエリを実行して結果を可視化する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Confluence をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- pandas をはじめとする多様なデータ分析・BI ツールにConfluence のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてConfluence の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
以下の手順に従い、必要なライブラリをインストールし、Python オブジェクト経由でConfluence にアクセスします。
必要なライブラリのインストール
pip で、pandas & Matplotlib ライブラリおよび、SQLAlchemy をインストールします。
pip install pandas pip install matplotlib pip install sqlalchemy
次にライブラリをインポートします。
import pandas import matplotlib.pyplot as plt from sqlalchemy import create_engine
Python でConfluence のデータを可視化
次は接続文字列を作成してConfluence に接続します。create_engine 関数を使って、Confluence に連携するEngne を作成します。以下はサンプルの接続文字列になりますので、環境に応じてクレデンシャル部分を変更してください。
engine = create_engine("confluence:///?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 にアクセスするSQL を実行
pandas のread_sql 関数を使って好きなSQL を発行して、DataFrame にデータを格納します。
df = pandas.read_sql("""SELECT Key, Name FROM Pages WHERE Id = '10000'""", engine)
Confluence のデータを可視化
DataFrame に格納されたクエリ結果に対して、plot 関数をつかって、Confluence のデータをグラフ化してみます。
df.plot(kind="bar", x="Key", y="Name") plt.show()
Confluence からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
ソースコード
import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin
engine = create_engine("confluence:///?User=admin&APIToken=myApiToken&Url=https://yoursitename.atlassian.net&Timezone=America/New_York")
df = pandas.read_sql("""SELECT Key, Name FROM Pages WHERE Id = '10000'""", engine)
df.plot(kind="bar", x="Key", y="Name")
plt.show()
関連コンテンツ
