各製品の資料を入手。
詳細はこちら →SQLAlchemy ORM を使って、Python でTrello のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でTrello にOR マッピング可能に。
最終更新日:2023-09-23
この記事で実現できるTrello 連携のシナリオ
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Trello は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Trello にデータ連携するPython アプリケーションを構築し、Trello のデータを可視化できます。 本記事では、SQLAlchemy でTrello に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Trello をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにTrello のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてTrello の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします:
pip install sqlalchemy
モジュールのインポートを忘れずに行います:
import sqlalchemy
Python でTrello のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Trello のデータに連携するEngne を作成します。
engine = create_engine("trello///?APIKey=myApiKey&Token=myGeneratedToken&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Trello は、トークンベース認証を使用して、サードパーティアプリケーションにAPI へのアクセスを許可します。ユーザーがアプリケーションにデータへのアクセスを許可すると、アプリケーションにはTrello のAPI へのリクエストに使用できるトークンが付与されます。 Trello のAPI には2通りの方法でアクセスできます。1つ目はTrello 独自の認可ルートで、2つ目はOAuth1.0 を使用する方法です。
- 認可ルート: 登録の時点で、Trello はAPI キーとトークンをアカウントに割り当てます。認可ルート経由で接続する方法については、ヘルプドキュメントの「認可ルートの使用」を参照してください。
- OAuth ルート: 認可の使用と同様に、OAuth は、アカウントの作成時にApplication Id とSecret を作成します。接続方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
Trello のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Boards テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。
base = declarative_base() class Boards(base): __tablename__ = "Boards" BoardId = Column(String,primary_key=True) Name = Column(String) ...
Trello のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("trello///?APIKey=myApiKey&Token=myGeneratedToken&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Boards).filter_by(Name="Public Board"): print("BoardId: ", instance.BoardId) print("Name: ", instance.Name) print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Boards_table = Boards.metadata.tables["Boards"] for instance in session.execute(Boards_table.select().where(Boards_table.c.Name == "Public Board")): print("BoardId: ", instance.BoardId) print("Name: ", instance.Name) print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Trello のデータの挿入(INSERT)
Trello のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Trello にすべての追加インスタンスを送ります。
new_rec = Boards(BoardId="placeholder", Name="Public Board") session.add(new_rec) session.commit()
Trello のデータを更新(UPDATE)
Trello のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Trello にレコードを追加します。
updated_rec = session.query(Boards).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Name = "Public Board" session.commit()
Trello のデータを削除(DELETE)
Trello のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Boards).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Trello からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。