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