agbee-api-python example

agbeeの外部連携APIにアクセスするpythonのExampleです。APIの利用方法については、こちらのAgbee APIリファレンスを参照してください。

環境構築

現在のpython環境にインストールする場合

git clone https://github.com/agbee-tech/agbee-api-python-example
cd agbee-api-python-example
pip3 install .

pyenv + poetryを利用する場合(Ubuntu)

前提環境をインストールをします。 python環境をインストールします。仮想環境はpyenvを推奨しています。

git clone git://github.com/yyuu/pyenv.git ~/.pyenv
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

pyenv install 3.12.2
pyenv versions
pyenv global 3.12.2

poetryをインストールします。

sudo apt update
sudo apt install pipx
pipx ensurepath
sudo pipx ensurepath --global

以下、poetryに紐付けるpythonのpathは使用する環境によって異なります。pyenvを使用する場合、下記の通り実行してください。

pipx install poetry==1.3.0
poetry env use /home/$USERNAME/.pyenv/shims/python

依存関係をインストールします。

git clone https://github.com/agbee-tech/agbee-api-python-example
cd agbee-api-python-example
poetry install

Run

.env.exampleファイルを参考に同じディレクトリ内に.envファイルを作成して、必要な項目を記入します。

cd agbee-api-python-example
# poetryの場合
poetry run python examples/simple_request_example.py

# pip installの場合
python examples/simple_request_example.py

サンプルプログラムの概要

ファイル名	説明
simple_request_example.py	requestsライブラリを使用してagbeeAPIに接続し、デバイスのリストを取得するプログラムです。
simple_gql_example.py	gqlライブラリを使用してagbeeAPIに接続し、デバイスのリストを取得するプログラムです。
subscription_gql_example.py	gqlライブラリを使用してagbeeAPIにサブスクリプションを行い、デバイスの状態変更を受信するプログラムです。
detect_wait_action_example.py	gqlライブラリを使用してagbeeがユーザーのボタン指示を待機している状態を検知するプログラムです。非同期のサブスクリプションを使用しています。

詳細プログラムのについてはこちらをご覧ください。