【初心者〜現場で活躍まで】挫折しないPython勉強方法もっと知る

【一括インストール】requirements.txtの使い方

【一括インストール】requirements.txtの使い方

Pythonで開発をすると、頻繁に「pip install」コマンドを使って、モジュールをインストールします。

この記事では、一括でモジュールをインストールできるrequirements.txtの使い方について解説します。

requirements.txtを使って、インストールするモジュールを管理できると、環境差異が原因のエラーを防げます。

エソラ

地味だけど、大切なTipsですので、ぜひとも最後までお読み下さい。

この記事を書いた人

エソラ
  • エンジニア歴10数年
  • SIerでDX推進を仕事に
  • Python、AWSを使ったアーキテクチャ設計・アプリ開発が得意
  • 30代、2児の父でサウナ好き
  • [icon-class=”icon-twitter”]Twitter

Pythonの勉強方法は、まとめ記事があります。

Pythonを勉強する時、何から勉強するか分からず、挫折します。初心者でも、中級者でも、レベルに合わせた勉強方法を分かりやすくまとめています。

目次

一括インストールする方法:pip install -r requirements.txt

requirements.txtを使って、モジュールを一括でインストールする方法は以下の通り。

pip install -r requirements.txt

インストールしたモジュールを確認する方法は、以下の通りです。

pip list
エソラ

非常に簡単ですね。GitHubでリポジトリをクローンした時やチームメンバーにプロジェクトを共有された時によく使います。

requirements.txtの作成方法

requirements.txtは、以下のように作成します。

STEP
requirements.txtという名前でファイルを作成する

まずは、requirements.txtという名前でファイルを作成します。

実際、別名でもOKですが、requirements.txtという名前で作成するのが暗黙のルールです。

ファイルを作る場所は、プロジェクトフォルダの直下に作ることが普通です。

project_folder
 L requirements.txt
STEP
requirements.txtにインストールしたいモジュールを書く

次は、インストールしたいモジュールをrequirements.txtに書きます。

boto3
opencv-python

これで完成です

requirements.txtにモジュールのバージョン情報を書く

requirements.txtでは、インストールするモジュールのバージョンを不等号を使って指定できます。

不等号実装例
==something==1.0.0
>something>1.0.0
>=something>=1.0.0
<something<1.0.0
<=something<=1.0.0
requirements.txtでバージョンを指定する方法

またカンマ(,)を使うと、複数条件を指定することができます。

something>= 1.0.0,<=2.0.0
エソラ

まぁ実際は、バージョンを固定したい場合が多いので、==の使用頻度が一番高いです。

バージョン情報をrequirements.txtに反映する方法:pip freeze

pip freezeを使えば、現在インストールしているモジュールのバージョン情報を確認できます。

これを利用すれば、開発時点でのバージョン情報をrequirements.txtに反映することができます。

個人開発でも、現場でのチーム開発でも、大きな悩みの種は環境差異です。pip freezeを使って、requirements.txtを書けば、以下のような問題が解消できます。

解決できる問題
  • ある日ソースコードが動かなくなった
  • チームメンバーに開発したプログラムを共有したら、動かなかった
エソラ

地味に感じるかも知れませんが、時間の無駄を防ぐため、丁寧に対応しましょう。

pip freezeを利用したrequirements.txtの書き方

pip freezeを利用したrequirements.txtの書き方は以下の通り。

STEP
バージョンの確認

まずは、インストールしたモジュールのバージョンを確認するため、以下のコマンドを入力します。

$ pip freeze

(省略)
pytest==7.1.3
(省略)

私の環境では、pytestのバージョンは7.1.3でした。

STEP
requirements.txtにライブラリとバージョン情報を書く

フォルダ直下にrequirements.txtを作成して、以下のように書きます。

pytest==7.1.3
STEP
requirements.txtを利用して、インストールする

requirements.txtを利用したインストール方法は以下の通り。

$ pip install -r requirements.txt

これで指定したバージョンのライブラリがインストールできます。

requirements.txtを使えば、環境差異がなくなる

ここまでの内容を復習すると、以下の通りでした。

この記事で解説したこと
  • pipを使いモジュールを一括でインストールする方法
  • requirements.txtの書き方
  • バージョン情報をrequirements.txtに反映する方法

requirements.txtを使って、モジュールのインストールを管理すると、個人開発でも、チーム開発でも、安心して、プログラムを書けます。

環境差異によるエラーを防げるので、無駄な時間の浪費がなくなります。

エソラ

ぜひとも使ってみて下さい。

Pythonが書ければ、現場でも重宝されます。ぜひともPythonをマスターして、市場価値を上げて下さい。

Pythonの勉強方法は、まとめ記事があります。

Pythonを勉強する時、何から勉強するか分からず、挫折します。初心者でも、中級者でも、レベルに合わせた勉強方法を分かりやすくまとめています。

ここまでお読みいただき、ありがとうございました。

役に立った、面白かったと思ったら、SNSでシェアしてくれると嬉しいです。

エソラ

もし分からないことがあれば、お問い合わせTwitterにご連絡をいただけると嬉しいです。(Twitterの方が返信早いかも…)

\ 更新の励みになるので、ポチッとしてね /

エソラ

他にもスキルアップやキャリアアップの役に立つ情報が満載です。他の記事も読んで、ゆっくりしていってね!

【一括インストール】requirements.txtの使い方

この記事が気に入ったら
フォローしてね!

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次