algolia
2020-03-15
2020-12-15
2 min

Python 3 を用いて Algolia の Index を取得する

thumbnail

1. はじめに

 Algolia では,豊富な API が公開されています。また,公開されている API を操作する各種言語のライブラリも公開されています。本記事では,Python を用いて Algolia の Index を取得する方法について記述します。

2. 前提条件

 これ以降は,以下の条件が整っている前提で記述します。

  • Algolia のアカウント登録済み
  • Algolia に Index を作成済み
  • Python3 がインストール済み
  • pip3 がインストール済み

3. 事前準備

 Algolia のデータを取得するには,Application IDAdmin API Key が必要になります。取得するには,Algolia のトッページから「API Keys」にアクセスすると表示されます。

4. 実装・実行

 Algolia のクイックスタートによると,algoliasearch をインストールする必要があるので pip3 を用いてパッケージをインストールします。

$ pip3 install --upgrade 'algoliasearch>=2.0,<3.0'

 ドキュメントを参考に,スクリプトを作成します。[APPLICATION_ID][ADMIN_API_KEY] には,上記で取得した Application ID と Admin API Key に置換します。[YOUR_INDEX_NAME] には,取得したい Index の名前に置換します。

#!/usr/bin/env python3

import json
from algoliasearch.search_client import SearchClient

client = SearchClient.create('[APPLICATION_ID]', '[ADMIN_API_KEY]')
index = client.init_index('[YOUR_INDEX_NAME]')

res = index.browse_objects()
print( json.dumps(obj=list(res), ensure_ascii=False, indent=2) )

 上記のスクリプトを実行し,JSON データが表示されれば正常に動作しています。また,標準出力をファイルに設定することで JSON ファイルとしてエクスポートすることもできます。

5. おわりに

 ここまで,Python を用いて Algolia の Index を取得する方法について記述してきました。Python 以外にも,Java や Golang,Scala なども同様の操作ができます。

環境情報

  • pip Ver.9.0.1
  • Python Ver.3.6.9
  • Zorin OS 15.2 Core (Ubuntu 18.04 LTS)