（最終更新日：2023年6月）
✔この記事が役立つと感じるであろう方
「requirements.txtの作成方法が知りたい」
「requirements.txtの適切な記述方法を学びたい」
「requirements.txtの実用的な例を参考にしたい」
✔この記事を通して伝えられる内容
- requirements.txtの基本概念
- requirements.txtの作成及び記述方法
- requirements.txtの実用的な例
当記事では、requirements.txtの基本概念から、適切な記述方法や活用例まで、具体的な事例を交えた詳細な解説を行なっています。
ぜひ最後までご覧ください。
筆者プロフィール
【現職】プロダクトマネージャー
【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作
「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。
【当ブログで紹介しているサイト】
✔人に見せても恥ずかしくないコードを書こう
「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。
- 見るからにきれいなコードの書き方
- コードの分割方法
- 変数や関数の命名規則
エンジニアのスタンダートとすべき基準を一から解説しています。
何回も読むのに値する本なので、ぜひ手にとって読んでみてください。
はじめに
まずはpythonのプロジェクト管理とパッケージ管理ツールについて見ていきましょう。
Pythonのプロジェクト管理とパッケージ管理ツールについて知ることのメリットを伝えることが目的です。
- プロジェクト管理の重要性
- パッケージ管理ツールの利用
プロジェクト管理の重要性
プロジェクト管理は、ソフトウェア開発プロセスにおいて不可欠な要素です。
適切なプロジェクト管理手法を使用することで、プロジェクトの計画、組織、制御、監視が効率的におこなえます。
以下がその具体的な理由です。
- 目標の達成: プロジェクト管理は、プロジェクトの目標や成果物の明確な定義と追跡を可能にします。適切な計画、タスクの割り当て、進捗の監視を行うことで、プロジェクトチームは目標の達成に向けて協力し、効果的に作業を進めることができます。
- リソースの最適化: プロジェクト管理は、リソース（人、時間、予算など）の効果的な活用を促進します。適切なタスクのスケジュール管理やリソースの割り当ては、プロジェクトの進行を円滑にし、無駄を最小限に抑えます。
- リスク管理: プロジェクトには様々なリスクが存在します。プロジェクト管理は、リスクの特定、分析、評価、対策の策定を行うことで、リスクを最小化しプロジェクトの安定性を確保します。
- コミュニケーションの促進: プロジェクト管理は、プロジェクト参加者間のコミュニケーションを強化します。プロジェクトの進捗状況や課題の共有、意思決定のサポートなど、適切なコミュニケーションチャネルを確立することで、チームの協力と効率性が向上します。
パッケージ管理ツールの利用
パッケージ管理ツールは、Pythonのプロジェクトにおいて依存関係の管理やパッケージのインストール、アップデートなどを効率的に行うためのツール。
以下に、パッケージ管理ツールの利点をいくつか説明します。
- 依存関係の管理: パッケージ管理ツールを使用すると、プロジェクトが依存する外部のライブラリやパッケージを簡単に管理できます。依存関係の解決やバージョン管理が自動的に行われるため、開発者は手動で依存パッケージを追跡する必要がありません。これにより、開発プロセスがスムーズに進み、コードの品質や安定性が向上します。
- バージョン管理: パッケージ管理ツールは、パッケージのバージョン管理を容易にします。パッケージのアップデートやダウングレードが簡単に行えるため、必要なバージョンのパッケージを簡単に取得できます。また、異なるプロジェクト間でのパッケージのバージョン衝突も回避できます。
- 仮想環境の作成: パッケージ管理ツールは、仮想環境を作成する機能も提供しています。仮想環境を使用すると、プロジェクトごとに独立したPython環境を構築できます。これにより、異なるプロジェクト間での依存関係の衝突を回避し、開発環境の整合性を保つことができます。
- パッケージの配布: パッケージ管理ツールは、パッケージの配布を容易にします。プロジェクトをパッケージ化して、他の開発者やユーザーと共有するための標準的な手法を提供します。パッケージの作成、公開、インストールが簡単に行えるため、プロジェクトの配布や共有がスムーズになります。
「requirements.txt」の概要
こちらでは、「requirements.txt」についてお伝えしていきます。
「requirements.txt」について知ることのメリットを伝えるとともに、その目的と役割、記述する情報について詳しく見ていきましょう。
- 「requirements.txt」の目的と役割
- ファイルに記述する情報
「requirements.txt」の目的と役割
「requirements.txt」は、Pythonプロジェクトで必要となるパッケージとそのバージョン情報を記述するファイルです。
このファイルにより、プロジェクトが必要とする全てのパッケージを一元管理することが可能となります。
新たに開発環境をセットアップする際に必要なパッケージを一括でインストールできるのです。
pip install -r requirements.txt
ファイルに記述する情報
「requirements.txt」に記述するのは、プロジェクトで使用するパッケージの名前とそのバージョン情報です。
基本的には、一行に一つのパッケージ名を記述し、必要に応じてその後ろにバージョン情報を追記します。
バージョン情報の記述はオプションで、記述がない場合は最新版が適用されます。
ただしプロジェクトの安定性を保つためには、使用するパッケージのバージョンを明示することが一般的といえるでしょう。
asgiref==3.5.2
backports.zoneinfo==0.2.1
beautifulsoup4==4.11.1
certifi==2022.12.7
cffi==1.15.1
charset-normalizer==2.1.1
cryptography==38.0.4
defusedxml==0.7.1
Django==4.1.3
django-allauth==0.51.0
django-bootstrap-datepicker-plus==5.0.3
django-bootstrap4==22.3
django-crispy-forms==1.14.0
django-filter==22.1
idna==3.4
oauthlib==3.2.2
pycparser==2.21
pydantic==1.10.4
PyJWT==2.6.0
python-dotenv==0.21.1
python3-openid==3.2.0
requests==2.28.1
requests-oauthlib==1.3.1
soupsieve==2.3.2.post1
sqlparse==0.4.3
typing_extensions==4.4.0
urllib3==1.26.13Pythonパッケージ管理ツールの紹介
こちらでは、「Pythonのパッケージ管理ツール」についてお伝えしていきます。
ツールごとの特性を理解することで、自身の開発環境やプロジェクトの要件に最適なツールを選択できるでしょう。
- pip
- conda
- poetry
- 各ツールの特徴と選び方
pip
pipはPythonで最も一般的に使われるパッケージ管理ツールです。
Pythonの公式パッケージリポジトリであるPyPI（Python Package Index）からパッケージをインストールできます。
また、pipは「requirements.txt」の作成やそれを元にしたパッケージの一括インストールもサポートしています。
conda
condaは、Anaconda distributionに含まれるパッケージ管理ツールです。
PythonだけでなくRやRubyなど他の言語のパッケージも管理することが可能。
とくに科学技術計算を行うためのパッケージを豊富に提供している点が特徴で、システム全体の依存関係を管理する能力も有しています。
poetry
poetryは、Pythonのパッケージ管理とプロジェクト管理を一元的におこなえるツールです。
依存関係の解決機能が強力で、またプロジェクトごとに独立した仮想環境を作成する機能を持つため、プロジェクト間でのパッケージの競合を避けられます。
各ツールの特徴と選び方
pipはPythonの公式パッケージ管理ツールであり、標準的なライブラリ管理に使用します。
Pythonパッケージのほとんどがpipでインストール可能で、要件ファイル「requirements.txt」を通じてのパッケージのインストールと管理が容易です。
pip intall -r requirements.txt一方、condaはデータ分析や機械学習など特定の分野で用いられるパッケージや、Python以外のパッケージも含めた環境全体の依存関係を管理することが可能です。
Anaconda distributionを使用している場合には、condaの使用が推奨されます。
poetryはPythonの新しいパッケージ管理ツールで、プロジェクト管理機能も兼ね備えています。
各プロジェクトに対して独立した仮想環境を作成でき、依存関係の管理も高度です。
大規模なプロジェクトや、複数のプロジェクトを並行して管理する必要がある場合に適しています。
どのツールを選択するかは、プロジェクトの規模や必要なパッケージ、作業環境などによります。
また、これらのツールは相互に排他的ではなく、状況に応じて適切なツールを選んで使い分けることも可能です。
「requirements.txt」の生成
こちらでは、「requirements.txt」の生成方法についてお伝えしていきます。
「requirements.txt」の生成方法を知ることのメリットは、プロジェクトにおける依存パッケージの一元管理と、開発環境の再現性向上につながります。
- 手動での新規作成方法
- pipでの自動生成方法
- 現在の環境から生成する方法: pip freeze
手動での新規作成方法
「requirements.txt」を作成する最も基本的な方法は、手動で新規作成することです。
テキストエディタを開き、使用しているパッケージ名とバージョンを一行ごとに書き込んでいきます。
例えば、numpyのバージョン1.18.5とpandasのバージョン1.0.3を使用している場合、以下のように記述します。
numpy==1.18.5
pandas==1.0.3これにより、必要なパッケージとそのバージョンが一目で分かります。
pipでの自動生成方法
手動で「requirements.txt」を作成することは、依存パッケージが少ない場合やバージョンを厳密に管理したい場合には有効です。
しかし、多数のパッケージを管理する必要がある場合や、既存の開発環境から「requirements.txt」を生成したい場合には、pipの自動生成機能を使用すると便利です。
pipのfreezeコマンドを使用することで、現在のPython環境にインストールされている全てのパッケージとそのバージョン情報を出力できます。
以下がそのコマンドです。
pip freeze > requirements.txtこれにより、現在の環境にインストールされている全てのパッケージとそのバージョンが「requirements.txt」に一覧として出力されるのです。
現在の環境から生成する方法: pip freeze
上述の通り、pip freezeコマンドを使用すると、現在のPython環境にインストールされている全てのパッケージとそのバージョン情報を取得できます。
以下のコマンドを実行しましょう。
pip freeze > requirements.txtこのコマンドにより、現在の環境にインストールされているパッケージの一覧が「requirements.txt」に保存されます。
このファイルを新しい環境にコピーし、以下のコマンドを実行することで、元の環境と全く同じパッケージをインストールすることができます。
pip install -r requirements.txt「requirements.txt」の記述ルール
こちらでは、「requirements.txt」の記述ルールについてお伝えしていきます。
「requirements.txt」の記述ルールを理解することのメリットは、より明確で効率的なパッケージ管理が可能になることです。
- パッケージ名の記述
- バージョン指定方法
- サンプルコード
パッケージ名の記述
「requirements.txt」に記述するパッケージ名は通常、小文字とハイフン（-）のみを使用します。
Pythonのパッケージ名は大文字と小文字を区別するため、正確な名前を使用することが重要です。
例えば、Pandasではなくpandasと記述する必要があります。
バージョン指定方法
パッケージ名の後にバージョンを指定することも可能です。
バージョンを指定すると、特定のバージョンのパッケージを強制的にインストールできます。
バージョン指定の方法は以下のような種類があります。
- 厳密なバージョン指定
- 最小バージョン指定
- バージョン範囲指定
厳密なバージョン指定
厳密なバージョン指定は、パッケージ名の後に==を使用してバージョン番号を記述する方法です。
numpy==1.18.5numpyのバージョン1.18.5がインストールされます。
最小バージョン指定
最小バージョン指定は、パッケージ名の後に>=を使用してバージョン番号を記述すること。
pandas>=1.0.0pandasのバージョン1.0.0以上がインストールされます。
バージョン範囲指定
バージョン範囲指定は、パッケージ名の後に>=と<=を使用してバージョン番号を記述します。
scipy>=1.2.0,<=1.5.0scipyのバージョンが1.2.0以上、かつ1.5.0以下の範囲で最新のものがインストールされます。
サンプルコード
それでは、これまで説明してきた内容をもとに、「requirements.txt」のサンプルを以下に示します。
numpy==1.18.5
pandas>=1.0.0
scipy>=1.2.0,<=1.5.0この「requirements.txt」を使用してパッケージをインストールすると、以下がインストールされます。
- numpy：バージョン1.18.5
- pandas：バージョン1.0.0以上の最新バージョン
- scipy：バージョン1.2.0以上かつ1.5.0以下の最新バージョン
これにより、プロジェクトで必要なパッケージとバージョンを正確に管理できるのです。
「requirements.txt」を使った一括インストール
こちらでは、「requirements.txt」を使った一括インストールの方法についてお伝えしていきます。
同じパッケージとバージョンの一括インストールにより、環境の再現性が向上し、トラブルを未然に防げるでしょう
- インストール手順
- 事例紹介
インストール手順
「requirements.txt」を用いてパッケージを一括インストールする手順は非常に簡単です。
まず、作業を行いたいPythonの環境に移動し、次に以下のコマンドを実行します。
pip install -r requirements.txt「requirements.txt」に記述されたパッケージが一括でインストールされます。
これにより、別の環境でも同じパッケージとバージョンのPython環境を簡単に構築が可能です。
事例紹介
データ分析プロジェクトにおいて、「requirements.txt」が以下のようになっているとします。
numpy==1.18.5
pandas>=1.0.0
scipy>=1.2.0,<=1.5.0この「requirements.txt」を新たな環境にコピーして、以下を実行しましょう。
pip install -r requirements.txt必要なパッケージをすべてインストールできます。
これにより、新たな環境でもプロジェクトをすぐに始めることができ、時間を大幅に節約できます。
よくあるトラブルと対処法
「requirements.txt」の使用中に起こり得るトラブルと、その解決方法について説明します。
「requirements.txt」を上手く使いこなすことで、これらのトラブルを防ぎ、Pythonプロジェクトの運用をスムーズにすることが可能です。
- パッケージの競合やエラー
- 依存関係のトラブル
- 解決方法
パッケージの競合やエラー
requirements.txtを使っていると、特定のパッケージがインストールできないといった問題が発生することがあります。
その理由は、複数のパッケージが同じリソースに依存し、バージョンが競合しているためです。
例えば以下のようなケースが考えられます。
- パッケージA：ライブラリXのバージョン1.0に依存
- パッケージB：同じライブラリXのバージョン2.0に依存
どちらか一方のパッケージしか正常に動作しないといった問題が生じます。
バージョン指定を通じて、共通するバージョンをインストールするようにしてください。
依存関係のトラブル
パッケージ間の依存関係が複雑に絡み合っている場合、一部のパッケージをアップデートするだけで他パッケージが動作しなくなるといった事態も起こり得ます。
一部のパッケージが、特定のバージョンのパッケージに依存しており、そのバージョンが変更されると動作しなくなるからです。
解決方法
これらの問題は、「requirements.txt」を適切に管理し、定期的にアップデートすることで解決可能です。
具体的には、以下のようなことを心がけましょう。
- パッケージのアップデートはまとめておこなわない
- ひとつずつまたは少数のパッケージを選んでアップデートする
- アップデートの都度テストをおこなう
また、複雑な依存関係を持つパッケージはvirtualenvやcondaなどの仮想環境で隔離することで、他のパッケージに影響を及ぼすことなく管理できることもあります。
まとめ
当記事の内容をまとめます。
- 「requirements.txt」の作成と活用は、Pythonプロジェクトの効率的な運用にとって不可欠
- 各パッケージのバージョンを厳密に管理することで、開発環境を統一し、プロジェクト全体の互換性を保てる
- 「requirements.txt」を用いれば、一括でパッケージをインストールできる
Pythonのパッケージ管理は、一度理解してしまえば大変便利なツールです。
とくに「requirements.txt」を活用すれば、プロジェクトの初期設定や共有、バージョン管理などが一元的におこなえます
開発者としての生産性を向上させるとともに、Python開発の更なる深みと広がりを感じられるでしょう。
当記事を通じて、Pythonのパッケージ管理の理解が深まり、より効率的なプロジェクト運用が可能となることを願っています。