くれなゐの雑記

例を上げて 自分で手を動かして学習できる入門記事を多めに書いています

pythonでなんか配布するときにいい感じにパッケージをインストールできるようにする(pipenv, requirements.txt 入門)

動機

インターンPythonを使って業務をしていたのだが,今までrequirements.txtを作ったことがなかったのでちょっと困った. ちゃんと仮想環境立ち上げて動くことは確認しよう!!!(戒め)

pipenv

Pipenv: 人間のためのPython開発ワークフロー — pipenv 9.0.1 ドキュメント

Pythonの仮想環境を使用するというとvirtualenv+pipでしょみたいな記事をよく見る(要出典). 個人的に,この組み合わせは導入が少し面倒だった印象がある.(virtualenvとpipをそれぞれ使うひつようもある) pipenvは簡単に導入でき,また簡単に仮想環境を立ち上げることができる.

pipenvは

pip install pipenv

でインストールすることができる.

バージョン情報

$ pip --version
pip 9.0.1 from /home/koh/.pyenv/versions/anaconda3-5.0.1/lib/python3.6/site-packages (python 3.6)
$ pipenv --version
pipenv, version 9.0.1

pipenv install

該当するリポジトリに移動し,

$ cd project_repository
$ pipenv install --three

これでpipenvの環境が構築できた. 楽ちん.

pipenv shell , pipenv run python

pipenv run pythonをすると,仮想環境のpythonが実行できる. 私はAnacondaを使っているので matplotlib がimportできるはずだが…

$ pipenv run python
>>> import matplotlib
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'matplotlib'

てなかんじでimportできなくなっている.これで指定したpythonであれば,この仮想環境上で動けば多分大丈夫!

pythonではなく,普通に仮想環境のshellに入りたいときは

pipenv shell

とする.

pipenv install package

ではimport matplotlibができるようにするためにはどうすればいいだろうか

pipenv install matplotlib

とする.これは

pip intall matplotlib

と似たような意味で,仮想環境上にmatplotlibを導入し,pipfileを更新してくれる

ではもう一度確認してみよう

import matplotlib

matplotlibも入った.

pipenv lock -r

さて,必要なパッケージをインストールして動作をすることが確認できたら次は requirements.txt を作成する. このファイルはそのライブラリに必要なパッケージをまとめて(バージョンを含めて)記載し,利用者側はコマンド一発でまとめてインストールすることができるというすぐれものである.

通常バージョンの記載等は面倒なのだが,pipenvを使用するとここがとても簡単にできる (catコマンドはファイルの中身を見ているという明示であって必要なコマンドではない)

$ pipenv lock -r > requirements.txt
$ cat requirements.txt
cycler==0.10.0 --hash=sha256:1d8a5ae1ff6c5cf9b93e8811e581232ad8920aeec647c37316ceac982b08cb2d  --hash=sha256:cd7b2d1018258d7247a71425e9f26463dfb444d411c39569972f4ce586b0c9d8
matplotlib==2.1.1 --hash=sha256:83a56f713c8126492081ec6b9e885fafb387e966e5c79b88bcdb15e41ca8dd33  --hash=sha256:769ccc141fb1891ecc2d39300ebb0efde16e7b4ce3d621fd61894a58676e23d4  --hash=sha256:c83c2009648e1cffde4a1fbd09718a6ae788040ea30f9024bff66fd66262ef39  --hash=sha256:d6bcda04e8eecac0286e2e893dd025f677a5b49f98872f6646b804e648e9da38  --hash=sha256:82d4b630f2b73f7282a5c18d64a3a4b2ad2fb9141e43309beb68893770b7127f  --hash=sha256:4871f85541b559ef10ab0f69f2251d2ac1dca4f14b0819f016191e6daf1ba03c  --hash=sha256:61107a27999fd6af94c5043f8493335b8b93e788a99ccd5e850bfaaa994a5a57  --hash=sha256:b8f516d63d81c6b0049bdb72d49e8d7f71b2cbb8f2c8e157354a12c728da20df  --hash=sha256:6271352603a629d0a1d50fdd98362575043058d354739a6d746eb699be7f81b9  --hash=sha256:6330d4923351be834abaf4e64ec3c6240947f7dd05d80ce932e09636939cead5  --hash=sha256:81de6cc0c1053e9439613475436504df1e5ea1d8072b49ab0dd1f41526085f6e  --hash=sha256:2c66b11ccd48b0aba68b6b8d2045536ff3368b178259762826e2fe2c6bc74b90  --hash=sha256:168c4fbccd155863ac37a6ccfe3b206a8267c34bc1c46d8e5901f72f6c160ee2  --hash=sha256:673acab3ea8733e639ddde7baf4ec665763e92871571d254fe00b592cfad99d4  --hash=sha256:c3a9e2699d63ae18e8c0242359b67725473e92fd60af73d334819dc52e1b53d4  --hash=sha256:4028fc0d48cc602fc8a0c399d41c20d052034763622d49ddf784da21315adec8  --hash=sha256:e4524148786bcdf936f8d431925073470d47197483bad69a21f217bb1e79d776  --hash=sha256:659f5e1aa0e0f01488c61eff47560c43b8be511c6a29293d7f3896ae17bd8b23
numpy==1.14.0 --hash=sha256:428cd3c0b197cf857671353d8c85833193921af9fafcc169a1f29c7185833d50  --hash=sha256:a476e437d73e5754aa66e1e75840d0163119c3911b7361f4cd06985212a3c3fb  --hash=sha256:289ff717138cd9aa133adcbd3c3e284458b9c8230db4d42b39083a3407370317  --hash=sha256:c5eccb4bf96dbb2436c61bb3c2658139e779679b6ae0d04c5e268e6608b58053  --hash=sha256:75471acf298d455b035226cc609a92aee42c4bb6aa71def85f77fa2c2b646b61  --hash=sha256:5c54fb98ecf42da59ed93736d1c071842482b18657eb16ba6e466bd873e1b923  --hash=sha256:9ddf384ac3aacb72e122a8207775cc29727cbd9c531ee1a4b95754f24f42f7f3  --hash=sha256:781d3197da49c421a07f250750de70a52c42af08ca02a2f7bdb571c0625ae7eb  --hash=sha256:93b26d6c06a22e64d56aaca32aaaffd27a4143db0ac2f21a048f0b571f2bfc55  --hash=sha256:b2547f57d05ba59df4289493254f29f4c9082d255f1f97b7e286f40f453e33a1  --hash=sha256:eef6af1c752eef538a96018ef9bdf8e37bbf28aab50a1436501a4aa47a6467df  --hash=sha256:ff8a4b2c3ac831964f529a2da506c28d002562b230261ae5c16885f5f53d2e75  --hash=sha256:194074058c22a4066e1b6a4ea432486ee468d24ab16f13630c1030409e6b8666  --hash=sha256:4e13f1a848fde960dea33702770265837c72b796a6a3eaac7528cfe75ddefadd  --hash=sha256:91101216d72749df63968d86611b549438fb18af2c63849c01f9a897516133c7  --hash=sha256:97507349abb7d1f6b76b877258defe8720833881dc7e7fd052bac90c88587387  --hash=sha256:1479b46b6040b5c689831496354c8859c456b152d37315673a0c18720b41223b  --hash=sha256:98b1ac79c160e36093d7914244e40ee1e7164223e795aa2c71dcce367554e646  --hash=sha256:24bbec9a199f938eab75de8390f410969bc33c218e5430fa1ae9401b00865255  --hash=sha256:7880f412543e96548374a4bb1d75e4cdb8cad80f3a101ed0f8d0e0428f719c1c  --hash=sha256:6112f152b76a28c450bbf665da11757078a724a90330112f5b7ea2d6b6cefd67  --hash=sha256:7c5276763646480143d5f3a6c2acb2885460c765051a1baf4d5070f63d05010f  --hash=sha256:3de643935b212307b420248018323a44ec51987a336d1d747c1322afc3c099fb
pyparsing==2.2.0 --hash=sha256:fee43f17a9c4087e7ed1605bd6df994c6173c1e977d7ade7b651292fab2bd010  --hash=sha256:0832bcf47acd283788593e7a0f542407bd9550a55a8a8435214a1960e04bcb04  --hash=sha256:9e8143a3e15c13713506886badd96ca4b579a87fbdf49e550dbfc057d6cb218e  --hash=sha256:281683241b25fe9b80ec9d66017485f6deff1af5cde372469134b56ca8447a07  --hash=sha256:b8b3117ed9bdf45e14dcc89345ce638ec7e0e29b2b579fa1ecf32ce45ebac8a5  --hash=sha256:8f1e18d3fd36c6795bb7e02a39fd05c611ffc2596c1e0d995d34d67630426c18  --hash=sha256:e4d45427c6e20a59bf4f88c639dcc03ce30d193112047f94012102f235853a58
python-dateutil==2.6.1 --hash=sha256:95511bae634d69bc7329ba55e646499a842bc4ec342ad54a8cdb65645a0aad3c  --hash=sha256:891c38b2a02f5bb1be3e4793866c8df49c7d19baabf9c1bad62547e0b4866aca
pytz==2017.3 --hash=sha256:80af0f3008046b9975242012a985f04c5df1f01eed4ec1633d56cc47a75a6a48  --hash=sha256:feb2365914948b8620347784b6b6da356f31c9d03560259070b2f30cff3d469d  --hash=sha256:59707844a9825589878236ff2f4e0dc9958511b7ffaae94dc615da07d4a68d33  --hash=sha256:d0ef5ef55ed3d37854320d4926b04a4cb42a2e88f71da9ddfdacfde8e364f027  --hash=sha256:c41c62827ce9cafacd6f2f7018e4f83a6f1986e87bfd000b8cfbd4ab5da95f1a  --hash=sha256:8cc90340159b5d7ced6f2ba77694d946fc975b09f1a51d93f3ce3bb399396f94  --hash=sha256:dd2e4ca6ce3785c8dd342d1853dd9052b19290d5bf66060846e5dc6b8d6667f7  --hash=sha256:699d18a2a56f19ee5698ab1123bbcc1d269d061996aeb1eda6d89248d3542b82  --hash=sha256:fae4cffc040921b8a2d60c6cf0b5d662c1190fe54d718271db4eb17d44a185b7
six==1.11.0 --hash=sha256:832dc0e10feb1aa2c68dcc57dbb658f1c7e65b9b61af69048abc87a2db00a0eb  --hash=sha256:70e8a77beed4562e7f14fe23a786b54f6296e34344c23bc42f07b15018ff98e9

なんか大量に出てきたがこれは いまpipenv上で動いている matplotlibと,その愉快な仲間たちが入っている. requirements.txtがあれば,Pipfileはなくても必要なパッケージをインストールすることができるし,requirements.txtからまたpipfileを生成できる. そのため,パッケージ関連はrequirements.txtのみ上げれば良い.

requirements.txtから読み込み(人のリポジトリをgit cloneした後の話)

ではrequirements.txtからデータを読み込むためにはどうすれば良いか. 以下の二通りの方法がある

  • pipを使う方法
  • pipenvを使う方法

pipを使う方法

pipを使う方法では,

$ pip install -r requirements.txt

でできる.

pipenvを使う方法

pipenvを使う方法では

$ pipenv install

で可能(requirements.txtは明記しなくて良い. 自動的に探してくれる) この方法で行った場合は,pipfile が生成されるため,またpythonを実行する際は

  • pipenv run python
  • pipenv shell
  • pipenv run python xxxx.py

などとする.