必要最低限のrequirements.txtを作成する (virtualenv版)
2017年に書いた、「必要最低限のrequirements.txtを作成する」という記事に未だに多少のアクセスがありまして、今現在でこれを参考にされてしまうとちょっとアレだなあと思いましたので。
(当時は Docker 憶えたてでイキっていました。反省)
クリーンな Python 環境を得るには virtualenv がおすすめ
virtualenv は、システムの Python 環境から、任意のディレクトリ以下に最低限のライブラリや実行ファイルをコピーし、クリーンな仮想 Python 環境を構成できるツールです。
通常は、開発したいプロジェクトやプロダクトごとに仮想環境を構成し、そのプロダクトに必要なライブラリだけ仮想環境にインストールして使用する、という使い方になると思いますが、開発で試行錯誤した結果、開発環境がプロダクションに不要なライブラリで汚染されていて整理したい、なんてこともあると思います。
そんなときは慌てず、別のディレクトリに改めてクリーンな仮想環境を作って、作成したソースコードをコピーした上で、改めて必要最低限のライブラリを pip install
してテストし、問題なければ pip freeze
してあげれば良いです。
使い方
virtualenv が未インストールであれば、インストールします。 pip install virtualenv
でインストールできますが、特定のバージョンを入れたいなどオプションについてはドキュメントを参照。
仮想環境を作りたいディレクトリに移動し、環境を作成します。
$ mkdir -p ~/path/to/project $ cd ~/path/to/project $ virtualenv . Using base prefix '/home/user/.pyenv/versions/3.7.5' New python executable in /home/user/path/to/project/bin/python3.7 Also creating executable in /home/user/path/to/project/bin/python Installing setuptools, pip, wheel... done.
すると、このディレクトリの下に bin
, include
, lib
というディレクトリができます。bin
以下にある activate
というスクリプトを source すると、仮想環境を使用するモードになります。
$ source bin/activate (project) $
プロンプトに (ディレクトリ名)
が付加されていれば、そのディレクトリの仮想環境に入っている状態です。
この状態で、必要なライブラリを pip install
し、 pip freeze
すれば、明示的にインストールしたライブラリと依存ライブラリだけのリストが出力されます。
仮想環境から出たい場合は deactivate
コマンドを実行する ( activate 時に alias が設定されている ) か、シェルからログアウトしてください。