pipで一括インストールする為のrequirements.txtの書き方

2021年2月24日水曜日

pip Python

t f B! P L

pip で必要なパッケージ名+バージョンをファイルに定義しておいて、一括でインストールする方法を紹介します。

npmコマンドでの、package.jsonに事前に依存関係を記述しておいて、npm installで一括でインストールやつを pipでもやってみます。

pipで一括インストールする為のrequirements.txtの書き方のイメージ

スポンサーリンク

定義ファイルを用意する

まずは、インストールするパッケージとバージョンを記述した定義ファイルを準備します。
ファイル名は何でもいいですが、慣例的にrequirements.txtというファイル名で作成します。

requirements.txtの書き方

公式サイトにサンプル及び、書き方の説明があったので、載せておきます。

###### Requirements without Version Specifiers ######
nose
nose-cov
beautifulsoup4

###### Requirements with Version Specifiers ######
#   See https://www.python.org/dev/peps/pep-0440/#version-specifiers
docopt == 0.6.1             # Version Matching. Must be version 0.6.1
keyring >= 4.1.1            # Minimum version 4.1.1
coverage != 3.5             # Version Exclusion. Anything except version 3.5
Mopidy-Dirble ~= 1.1        # Compatible release. Same as >= 1.1, == 1.*
#
###### Refer to other requirements files ######
-r other-requirements.txt
#
#
###### A particular file ######
./downloads/numpy-1.9.2-cp34-none-win32.whl
http://wxpython.org/Phoenix/snapshot-builds/wxPython_Phoenix-3.0.3.dev1820+49a8884-cp34-none-win_amd64.whl

では、一つずつ書き方を見ていきましょう。

最新バージョンを取得する場合の書き方

最新バージョンを取得する場合の書き方は、バージョン番号などは指定せず、パッケージ名だけ記述します。

nose

バージョン指定する場合の書き方

パッケージ名の横に、条件とバージョン番号を指定することで、指定したバージョンのパッケージをインストールする事が出来ます。

**▪️ バージョン指定 **

docopt == 0.6.1

▪️ 指定バージョン以上

keyring >= 4.1.1

▪️ 指定バージョンを除く

coverage != 3.5

▪️ AND条件

package >= 1.0, <=2.0

外部の定義ファイルを取り込む時の書き方

複数のファイルに分割してパッケージの定義を行う場合、以下の書き方で、外部の定義ファイルを取り込む事が出来ます。

-r other-requirements.txt

whlファイルを使ってインストールする場合の書き方

./downloads/numpy-1.9.2-cp34-none-win32.whl

環境マーカー

バージョン6.0以降、環境マーカーという物も使えるようになっています。

▪️ python_versionのバージョンが '2.7’以下の時にインストール

SomeProject ==5.4 ; python_version < '2.7'

▪️ Windows環境の場合にインストール

SomeProject; sys_platform == 'win32'

スポンサーリンク

現在インストールされいるパッケージを書き出す pip freeze

これまでとは逆で、自分の環境にインストールされているパッケージをrequirements.txtに書き出す方法もあります。

お試しで作った環境を正式版にする時に、現在の環境情報をrequirements.txtに書き出す時に使えそうです。

出力するには、以下のコマンドを入力します。

pip freeze

結果は以下のように出力されます。pip install -rで使える設定ファイルの形式で出力されているのが分かると思います。

Flask==1.0.2
Flask-RESTful==0.3.6
Flask-SQLAlchemy==2.3.2

Anaconda環境で「requirements.txt」を出力

Anaconda環境下の場合、インストールされているパッケージの一覧を「requirements.txt」に出力する場合は、次のコマンドを使用する。

conda list -e > requirements.txt

しかし、Anacondaではあまり「requirements.txt」を使うことはなく、次のコマンドで仮想環境の定義をYAML形式でエクスポートすることが大半である。

conda env export > myenv.yaml

上のコマンドを叩くと、次のようなファイルが出力される。

name: python37
channels:
  - defaults
  - conda-forge
dependencies:
  - blas=1.0=mkl
  - branca=0.4.2=pyhd8ed1ab_0
  - brotlipy=0.7.0=py37h9ed2024_1003
  - ca-certificates=2021.1.19=hecd8cb5_0
・・・

上記でエクスポートした環境を、インポート(再構築)する場合は、次のコマンドを使用します。

conda env create -f=myenv.yaml
スポンサーリンク

QooQ