はじめに

このドキュメントは、ハイラブル株式会社の提供する製品群を操作するための SDK のドキュメントです。対応している製品は次の2つです。

Hylable Discussion
Bamiel

クイックスタート

アカウント情報の設定

Hylable SDK の利用に必要な情報は次の4つです。

organization: 組織名
username: ユーザー名
password: パスワード
client_id: SDK 提供時に設定される ID

これらの情報は、設定ファイルに保存します。

以下の設定ファイルをテキストで作成して $HOME/.hylable/config に保存します。

[default]
organization = 組織名
username = ユーザー名
password = パスワード
client_id = クライアントID

なお、[] に入れるプロフィール名を変えることで複数の認証情報を保存することもできます。このプロフィール名は、クライアントオブジェクト (例: HDClient) の作成時に指定します。

また、環境変数 HYLABLE_CONFIG_PATH が設定されていれば、config ファイルの読み込み先を指定できます。

プログラムの作成 (Hylable Discussion)

次のサンプルプログラムは、コース名とそのID、そしてそのコースに保存されているディスカッションの数を一覧表示するプログラムです。

import hylable

client = hylable.HDClient(profile_name="default")
# profile_name が "default" の場合は省略可能

for course in client.get_courses():
    discussions = client.get_discussions(course.id)
    print(f"{course.name} [{course.id}] {len(discussions)}")

プログラムの作成 (Bamiel)

次のサンプルプログラムは、すべてのフィールドの名前とID、定義されているエリアの数を表示するプログラムです

import hylable

client = hylable.BamielClient(profile_name="default")
# profile_name が "default" の場合は省略可能

for field in client.get_fields():
    print(f"[{field.id}] ({len(field.areas):-4d}) {field.name}")