セットアップ

セットアップ

Basepair Python パッケージおよび関連するコマンド ライン インターフェイス (CLI) のインストールについて説明します。 このページの内容の概要は次のとおりです。

  1. インストール
  2. 設定

1. インストール

要件

Pythonバージョン3。Python 2 は積極的にサポートされなくなりました。

まず、basepair Python パッケージをインストールする必要があります。

pip install basepair

インストールすると、「basepair」ツールがコマンド ラインで使用できるようになります。 ターミナルで次のコマンドを実行してみてください。

basepair -h

2. 構成

Basepair の API に接続するには、構成ファイルを取得する必要があります。 ファイルを取得するには:

  1. Basepair ダッシュボードに移動します: https://app.basepairtech.com
  2. 右上隅にあるプロフィール名をクリックします
  3. 「Profile」をクリックします
  4. 右上隅の「Download API config file」をクリックします

設定（configuration）ファイルを取得すると、次のようになります。

{
  "api": {
    "cli": true,
    "host": "app.basepairtech.com",
    "prefix": "/api/v2/",
    "ssl": true,
    "username": "user@basepairtech.com",
    "key": ""
  }
}

「key」は、Basepair アカウントにアクセスできるようにする一意のコードです。

このファイルを API 呼び出しで使用できるようにするには、次のいずれかを実行できます。

オプション 1：環境変数を定義する

export BP_CONFIG_FILE=/path/to/basepair.config.json

オプション 2：basepair を呼び出すときにパラメータとして指定する

basepair -c /path/to/basepair.config.json

Basepair のゲノミクスツールスイートをコマンド ラインまたは Python API 経由で使用できるようになりました。 使用方法については、「コマンドラインAPI」または「Python API」チュートリアルを参照してください。