【Python】requirementsの使い方

Pythonでrequirements.txtを使ったパッケージ管理について紹介します。

はじめに

この記事では
・requirements.txtの作成方法
・requirements.txtを使ったインストール方法
についてまとめました。

requirements.txtとは

「requirements.txt」はPythonパッケージをまとめたリストのことです。
requirements.txtを使ってパッケージを一括でインストールすることができます。

主な用途としてローカル環境で使用していたパッケージをrequirements.txtにして、
本番環境に適用したり、Dockerコンテナ作成時にパッケージを自動インストールする際に使用します。

requirements.txtの作成

以下のコマンドを実行すると「requirements.txt」ファイルが生成されます。

pip freeze > requirements.txt

作成された「requirements.txt」ファイルの中を確認すると、パッケージのリストが記載されています。
（今回は事前にrequestsパッケージをインストールしておきました。）

「requirements.txt」のファイル名は任意ですが、requirements.txtという名前が使われることが多いです。

requirements.txtを使ったインストール

作成したrequirements.txtファイルを使って、新しい環境に
以下のコマンドを使ってパッケージを一括でインストールします。

pip install -r requirements.txt

新しい環境では、まだパッケージがインストールされていない状態です。

それでは、インストールしてみます。

インストール後に「requirements.txt」を作成して、比較してみると同じパッケージがインストールされています。

まとめ

開発環境のパッケージを本番環境やDockerコンテナも使用したい場合したい場合に
「requirements.txt」を使うと本当に便利です。
みなさんもぜひ使ってみてください。

あわせて読みたい

【Python】pyenv バージョン管理（Windows） Windowsにpyenvを使ってPythonバージョンを切り替える方法を紹介します。 【はじめに】 この記事では、「Windowsにpyenvを使ってPythonバージョンを切り替える方法」に...