できない.dev

requirements.txt

別名: requirements file / requirements ファイル / pip install -r

requirements.txt は、pip にインストールさせるパッケージを 1 行に 1 つずつ並べたテキストファイルである。
pip install -r で読み込み、pip freeze の出力から作ることが多い。

公開:

定義

requirements.txt は、pip にインストールさせるものを並べた requirements ファイルである。
各行には、インストールするパッケージか、pip install に渡すオプションを書く。
pip install -r requirements.txt と打つと、pip はこのファイルを読んで書かれたものをインストールする。

詳細

公式ドキュメント(新しいタブで開く)によると、版の指定は requirement specifier と同じ書き方をする。
# から行末まではコメントになり、-r で別の requirements ファイルを読み込める。

# 本番で使うパッケージ
requests >= 2.31
docopt == 0.6.1
-r requirements-dev.txt

今の環境に入っているパッケージを版ごと書き出すには、pip freeze > requirements.txt を使う。
文字コードは、指定が無ければ UTF-8 として読まれる。

よくある誤解

requirements.txt という名前は慣習で、pip が決めたものではない。
pip はファイルを自動では探さないので、-r に渡したパスにファイルが無いと Could not open requirements file で止まる。

ファイルに書いた順にインストールされるとは限らない。
依存の解決には、各パッケージのメタデータが使われる。

関連

プロジェクトの設定と依存をまとめて書く新しい形式は pyproject.toml である。
インストール先を分けるには venv を使う。