pyzaimflow 0.0.2

マネー・プラットフォーム「Zaim」からデータを取得するためのパッケージ

pyzaimflow

pyzaimflow は、株式会社くふうカンパニーホールディングスが運営するマネー・プラットフォーム「Zaim」からデータを取得・連携し、スクレイピング機能を提供する Python パッケージです。

概要

pyzaimflow が提供する主な機能は以下のとおりです。

• Zaim API を使ったデータ操作（登録、取得、更新、削除）。
  • Zaim が提供する Web API を扱いやすくするラッパー機能を提供します。
  • Zaim の Oauth 1.0a 認証ができる CLI を提供します（提供予定）。
• Zaim の Web 画面をスクレイピングして、API では取得できないデータを収集します（提供予定）。
  • たとえば手入力の取引や銀行／クレジットカードの明細など、API で取得できない情報を補完します。

推奨環境

• OS
  • 22.04.5 LTS (Jammy Jellyfish)
• Python バージョン
  • 3.10.12 以上

事前準備

くふう.Zaim にアクセスして Zaim のアカウントを作成してください。アカウントの作成方法はリンク先をご参照ください。本ドキュメントではアカウント作成手順については省略します。

インストール

pip install pyzaimflow

準備

Zaim API を呼び出すには、以下の 2 つの値が必要です。

• コンシューマ ID
• コンシューマシークレット

コンシューマ ID、コンシューマシークレットの取得方法

くふう.Zaim が提供する Zaim Developers Center からそれぞれの値を取得します。

1. Zaim Developers Center にアクセスし、ログインします。
2. 画面上部の「新しいアプリケーションを追加」リンクをクリックします。
3. 「アプリケーションを登録」画面に 必要な項目 を入力し、保存ボタンをクリックします。
4. 遷移先の画面に「コンシューマ ID」、「コンシューマシークレット」が表示されます。

アプリケーションを登録画面に入力する項目について

「アプリケーションを登録」画面で入力する値は以下のとおりです。※入力する値は本パッケージを利用するユーザーが適宜変更して入力してください。

項目	値	備考
名称	pyzaimflow	任意の値を設定
サービス種	● ブラウザアプリ ○ クライアントアプリ	ブラウザアプリまたはクライアントアプリのいずれかを選択してください
概要	pyzaimflow で Zaim のデータ操作	任意の値を設定
組織	pyzaimflow	任意の値を設定（日本語可）
サービスの URL	https://example.com	任意の URL を設定
アクセスレベル	☑家計簿の記録を読み込む ☑家計簿の記録を書き込む ☐家計簿へのアクセスを永続的に許可する	「家計簿の記録を読み込む」とは、ユーザーのデータを読み取る権限を付与することを意味します。 「家計簿の記録を書き込む」とは、ユーザーのデータを書き込む権限を付与することを意味します。 「家計簿へのアクセスを永続的に許可する」とは、ユーザーが一度 Zaim での利用を許可すると、ユーザーが Zaim を退会するか、許可を取り消すまで、いつでもユーザーのデータにアクセスできることを意味します。この項目にチェックを入れない場合、許可は24時間で失効します。
アイコン画像	-	登録しなくても構いません。後から変更できます。