【Python】 requirements.txt の使用方法の備忘録

Python

2024.01.27

この記事は約2分で読めます。

記事内に広告が含まれています。

この記事を訪れている人の中で requirements.txt って何だろうって思う人は少ないと思います。

が、出力方法やインストール時のコマンドはパッと出て来ないことが多いので、備忘録として記載します。

requirements.txt の役割

Python でアプリケーション開発を行う際に、ルートディレクトリにある requirements.txt にはライブラリ・パッケージのバージョンが定義されていますよね。

ローカル環境をセットアップする際に、同じバージョンのライブラリ・パッケージを使用するための定義です。

requirements.txt は、そのプロジェクトが依存する外部Pythonライブラリやパッケージのリストを含んでいます。

他の開発者が同じ環境を簡単に再現できるようにするために用いられます。

通常、以下のような形式で記述されます。

package1==1.0.4
package2>=1.0.3
package3

この例では、 package1 はバージョン 1.0.4 に固定されます。

package2 は 1.0.3 以上のバージョンが要求され、package3 は特定のバージョンが指定されていません。

意図せぬバージョンが当たらないように、通常は固定することが多いのではないでしょうか。

既存の環境から requirements.txt を生成するには、以下のコマンドを使用します。

pip freeze > requirements.txt

現在の Python 環境にインストールされているすべてのパッケージをリストし、それを requirements.txt ファイルに出力します。

requirements.txt を使用して依存関係をインストールするには、以下のコマンドを使用します。

pip install -r requirements.txt

このコマンドは requirements.txt にリストされているすべてのパッケージをインストールします。

pip instal lコマンドで使用される -r オプションは「requirement」を意味します。

このオプションに続いて指定されたファイル（この場合は requirements.txt ）に記載されているすべてのパッケージをインストールすることを指示します。

よく使うコマンドなのにパッと出てこないことは多いので、自分用の備忘録を作るか、社内の共通のページに書いておきたいですね。