本記事はpipreqsによるpythonプロジェクトのrequirements.txtの生成方法についてご紹介します。

pipreqsについて

pipreqsは、Pythonプロジェクトの依存関係を自動的に検出し、requirements.txtファイルを生成するツールです。
プロジェクト内のimport文を解析し、外部パッケージを見つけ出し、それらのパッケージとそのバージョンをrequirements.txtに出力してくれて非常に便利なツールです。

メリット

手動でrequirements.txtを作成する手間を省くことができます。これにより、プロジェクトを他の環境に移動させる際や、仮想環境を再作成する際などに非常に便利です。

pipreqsのインストール方法

pip install pipreqs

利用方法

インストールが完了したら、Pythonプロジェクトのディレクトリに移動して以下のコマンドを実行します：

pipreqs /path/to/your/project

これにより、指定したプロジェクト内のPythonファイルを解析し、requirements.txtファイルを生成します。

注意点

pipreqsは必ずしも完璧なリストを提供するわけではありません。人的要素で不要なパッケージが含まれたり、必要なパッケージが漏れていることがあります。
ですので、生成されたrequirements.txtを確認し、必要なら手動で修正することがおすすめです。