requirements.txtで複数の環境でバージョンを統一する

概要

Pythonで開発する際、インストールするパッケージのバージョンは、開発環境と本番環境で統一することがオススメされている。
バージョンを統一することで、各環境で動作が同じになり、「開発環境では問題なく動作していたが、本番環境では不具合が発生した」といったトラブルが防げます。
pipではパッケージ名とバージョン番号を指定したテキストファイルを用意することで、バージョンを統一できます。
テキストファイルの名前はrequirements.txtがよく使われます。

手順

requirements.txtを作成するには下記コマンドを実行します。

pip3 freeze > requirements.txt

編集

ターミナルで編集する時は下記コマンドを実行します。

cat requirements.txt

エディタで編集することもできます。

requirements.txtの書き方例

# 先頭に"#"を入れた行はコメントになる
# 行の途中でもスペースの後に"#"があると、"#"以降はコメントになる
foo==1.0.0 # "=="だと指定されたバージョンがインストールされる
bar<2.0.0,>=1.2.0 #　バージョンの範囲指定もできる
div # バージョン番号を指定しなければ、インストール実行時点での最新版がインストールされる

補足

requirements.txtを参照してパッケージをインストールするには下記コマンドを実行する

pip3 install -r requirements.txt