Python のコマンドラインツールである virtualenvwrapper についてご紹介します。
virtualenvwrapper はその名前のとおり virtualenv の wrapper で、便利な virtualenv ライブラリをより使いやすくしてくれるラッパーツールです。 Windows には対応しておらず Linux と Mac 限定のツールとなっています。
以下に、特徴と初期設定、基本的な使い方を説明します。
特徴
virtualenvwrapper の特徴として次の6つが公式ドキュメントにあげられています（意訳です）。
- すべての virtualenv 環境を一元管理できる
- 便利な各種コマンド
- 環境の切り替えがコマンドひとつで
- タブによるコマンド補完
- カスタマイズ可能なフック
- 拡張機能も自由に開発可
初期設定
まずは virtualenvwrapper そのものをインストールします。 virtualenv がインストールされていなければ先にインストールしておきます。
$ pip install virtualenvwrapperインストールが完了したら virtualenvwrapper を有効化します。具体的には、環境変数 WORKON_HOME を設定し、 virtualenvwrapper.sh を実行します。
export WORKON_HOME=$HOME/.virtualenvs
source (適切なパス)/virtualenvwrapper.shここで、 WORKON_HOME は virtualenv 環境を一元管理するディレクトリを指定するための変数です。ここではユーザホーム直下の .virtualenvs というディレクトリを使っていますがこの場所である必要は特にありません。
virtualenvwrapper.sh は virtualenvwrapper を有効化するためのシェルスクリプトです。システムの Python で virtualenvwrapper を入れた場合は /usr/local/bin あたりにあることが多いようです。
ここまで無事に準備が済んでいれば「workon」コマンドが使えるようになっています。
workon --helpちなみに、この WORKON_HOME の設定と virtualenvwrapper.sh の読み込みのコマンドは、いつでも使えるようにターミナルの起動スクリプト（ .bashrc など）で設定しておくと便利です。
基本的な使い方
virtualenv 環境の作成、一覧、切り替え、削除などを見ていきます。
virtualenv 環境の作成は mkvirtualenvwrapper コマンドを使います。
mkvirtualenvwrapper 環境名いろいろなオプションがあるため、詳しくは 公式ドキュメントの該当箇所 をご覧ください。オプションの一部として次のようなものがあります。
--python=使用する Python ランタイムのパス: 使用する Python のランタイムを指定する--no-site-packages: グローバルのパッケージは使わない設定にする
mkvirtualenvwrapper で環境の作成に成功したら、自動的にその環境が有効化されます。どの環境が有効化されているかはターミナルのプロンプトでわかります。一般にプロンプトの先頭に (環境名) が付いていればその環境に入れていることになります。
作成済みの環境を一覧するには workon コマンドを使います。
workonvirtualenv 環境を複数作っている場合の環境の切り替えも workon コマンドで行います。
workon 環境名有効化された環境から抜けるには deactivate コマンドを使います。
deactivate存在する環境を削除するには rmvirtualenv コマンドを使います。
rmvirtualenv 環境名基本的な操作はこの 4 つのコマンドだけでできますが、他にも豊富なコマンドが用意されています。詳しく知りたい方は公式のコマンドリファレンスをご覧ください。
参考
virtualenvwrapper: