AWS Cloud9の設定まとめ｜タイムゾーン・venv・フォーマッター・GitHub連携

はじめに

AWS Cloud9はブラウザだけで開発できるIDEで、EC2インスタンスの上で動きます。使い始めるときに毎回やる設定をまとめました。

タイムゾーンを日本時間にする

Cloud9のインスタンスは既定でUTCです。ログの時刻がずれるので変更しておきます。Amazon Linux 2 の場合の手順です。

# 設定ファイルをバックアップ（ファイルが無ければ次の行から）
$ sudo cp /etc/sysconfig/clock /etc/sysconfig/clock.org

# ZONE="UTC" を ZONE="Asia/Tokyo" に書き換える
$ sudo vim /etc/sysconfig/clock

# ローカル時間の参照先を日本時間に向ける
$ sudo ln -sf /usr/share/zoneinfo/Asia/Tokyo /etc/localtime

# 再起動して反映
$ sudo reboot

# 確認
$ date

venv環境を使えるようにする

Cloud9で仮想環境を作った場合、IDE側にも場所を教える必要があります。

PYTHONPATHを設定する

Project Settings > Python Support > PYTHONPATH に、仮想環境の site-packages を指定します。

/home/ubuntu/environment/仮想環境名/lib/python3.8/site-packages:/usr/local/lib/python3.8/dist-packages

コロン区切りで複数指定できます。

Runnerを作る

Run > Run With > New Runner から、仮想環境のPythonで実行するRunnerを作ります。

{
  "cmd": [
    "/home/ubuntu/environment/仮想環境名/bin/python3.8",
    "$file",
    "$args"
  ],
  "selector": "source.py"
}

$file は開いているファイル、$args は実行時の引数に置き換わります。

保存時にコードを自動整形する

Preferences > Project Settings > Python Support で Format Code on Save をオンにし、Custom Code Formatter に次を入力します。

black "$file"; isort "$file"

これでファイルを保存するたびに、Blackで整形してからisortでインポートを並べ替えてくれます。

事前にインストールしておきます。

$ pip install black isort

GitHubにSSHで接続する

1. キーペアを作る

Cloud9のターミナルから作成します。

$ ssh-keygen -t ed25519 -C "your_email@example.com"

保存先を聞かれたらEnter、パスフレーズは任意で入力します。作成した公開鍵を表示します。

$ cat ~/.ssh/id_ed25519.pub

2. GitHubに公開鍵を登録する

Settings > SSH and GPG keys > SSH keys から New SSH key を押し、次を入力します。

• Title … 環境が分かる名前（cloud9 など）
• Key type … Authentication Key
• Key … cat で表示した公開鍵を貼り付ける

3. Gitのユーザー設定

$ git config --global user.email your_email@example.com
$ git config --global user.name your_name

4. 接続を確認する

$ ssh -T git@github.com

Hi <ユーザー名>! You've successfully authenticated と表示されれば成功です。

コード補完を有効にする

左カラムの aws > DEVELOPER TOOLS から、コード補完の Auto-Suggestions をオンにします。有効になると画面下部に印が付きます。

データ収集をオフにしたい場合は、Preferences > Project Settings を開き、EC2 Instanceの次にある AWS Toolkit の項目まで進んで AWS: Telemetry をオフにします。

おわりに

Cloud9は環境をまるごとクラウドに置けるのが利点でしたが、新規提供が終了した以上、これから環境を作るなら別の手段を選ぶことになります。

すでに動いている環境については、ここまでの設定を一度済ませてしまえば当分触ることはありません。特にRunnerの設定ファイルが2か所にある点は、削除しようとして初めて気づくところなので覚えておくと役に立ちます。