メインコンテンツへスキップ
XDK Python SDK は GitHub リポジトリから直接取得し、pip でインストールできます。

前提条件

  • Python 3.8 以降
  • 仮想環境用の pip および venv(推奨)

クイックインストール

GitHub のサブディレクトリにある XDK をインストールします。
pip install xdk
これにより、main ブランチから最新の生成済みバージョンが取得されます。

開発用インストール

開発やコントリビュートを行う場合は、以下の手順に従ってください。
  1. リポジトリをクローンします:
    git clone https://github.com/xdevplatform/xdk.git
    cd xdk/python
    
  2. 依存関係を編集可能(editable)モードでインストールします:
    pip install -e .
    
    これにより、SDK とその実行時依存関係がインストールされます。
  3. (任意)テスト/Lint 用の開発依存関係をインストールします:
    pip install -e .[dev]
    

検証

インストールを確認します:
import xdk
print(xdk.__version__)  # XDKのバージョンを出力します
注: XDK は OpenAPI 仕様から自動生成されているため、変更点がないか必ず X API changelog とリポジトリ内の XDK リリースノートを確認してください。 Python XDK を使った詳細なコード例については、コードサンプルの GitHub リポジトリ を参照してください。