pipenvを使用したPython開発環境の作り方

pipenv とは？¶

pipenv とは、Anaconda のような Python の環境構築ツールの１つで
pip + virtualenv を組み合わせたものです。
これを使用することで、Python の仮想環境を作りつつ、かんたんに pip を使用したモジュールのインストールを
行うことができます。

py.exe¶

これを説明する前に、 py.exe について触れておきます。
py.exe とは、最近の Python をインストールすると一緒にインストールされる
複数の Python をインストールしている場合の使用バージョンスイッチを用意にしてくれるものです。
exe は C:/Windows/py.exe に入っているので、コマンドライン上では py というコマンドで使用することができます。

使い方は、

py -3.6

このようにすると、指定のバージョンの Python を使用できます。

これを活用することで、環境変数の PythonPath を毎度変えたりすることなく
Python を使用することができます。

で、一般的には pip.exe があるフォルダに PATH を通すことで

pip install hogehoge

のようにしていますが、固定のバージョンのフォルダ下に PATH を通さずに
py を使用することでも pip install を使用することができるので
そちらを利用して説明していきます。

インストール方法¶

というわけで、まずは pipenv を使えるようにインストールします。

1	`py -3.6 -m pip install pipenv`

今回は、python3.6 を基準として扱う Python として使用するので -3.6 とします。

インストールが完了すると

1	`py -3.6 -m pipenv ～～～`

これで、pipenv を使用することができます。

インストール先を変更する¶

準備ができたら、次に pipenv の設定をします。
pipenv は、仮想環境を .venv 下に作成するのですが、
デフォルトだと HOME 下に仮想環境が作成されてしまうので、プロジェクト下になるように環境変数で指定します。

1	`PIPENV_VENV_IN_PROJECT=true`

この設定を入れておくと、現在のフォルダ下に .venv が作成されます。

Version を指定して PIPENV の環境を作成する¶

準備ができたら、実際の環境を作っていきます。

仮想環境を作りたい Python のプロジェクトフォルダのルートに移動して、
以下のコマンドを実行します。

1	`py -3.6 -m pipenv --python 3.6 install`

pipenv での環境構築は、 --python ### install の ### ここで
仮想環境のバージョンを指定することができます。
上の場合は 3.6 用の仮想環境をつくります。

構築が完了したら、このように .venv フォルダができあがります。
これでもとりあえず OK なのですが、
これだと毎回 py -3.6 pipenv のように書かないといけないので

1	`py -3.6 -m pipenv install pipenv`

作成した仮想環境にも pipenv を入れておきます。

1	`py -3.6 -m pipenv shell`

pipenv が入れ終わったら、作った仮想環境をセットします。

VSCode の設定¶

まず、pipenv をインストールしたフォルダを開きます。

特に何もしていない場合は、こんな感じでインタープリタが指定されていませんので

インタープリタの選択の中から作成した pipenv の環境を選択します。

この設定をすると、VSCode のターミナルを開いたときに自動的に .venv にアクティベートした
状態でコンソールを開いてくれるので

1	`pipenv install pyside2`

こんなかんじで、pip を使用するのと同じ感覚で仮想環境にモジュールをインストールすることができます。

pipenv の主要なコマンド¶

cmd
install	指定のパッケージを pipenv にインストールすｒ。（バージョン指定も可）
run	Python のコマンドを実行する。
shell	現在のフォルダの仮想環境で Shell を起動する。
lock	Pipenv.lock ファイルを作成する。
update	lock コマンドを実行後、その時同期する
clean	Pipenv.lock に記載されていないすべてのパッケージをアンインストールする

設定済みファイルから環境を構築する¶

pipenv は、設定ファイルをベースに仮想環境を再構築することができます。

[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
jupyter = "*"
notebook = "*"
ipykernel = "*"
pyside = "*"
qt-py = "*"
pyopengl = "*"

[dev-packages]

[requires]
python_version = "2.7"

まずは、空のフォルダに Pipfile という名前の空のテキストを作成します。
作成したファイルを開いて、↑ のようにインストールしたいパッケージや、Python のバージョンを
記載して保存します。
このファイルは、 pipenv install hogehoge したときに作成されるファイルで
すでに別の仮想環境を作っていた場合はファイルが作成されています。
ので、すでにあるファイルをコピペしてくるのでも OK です。

次に、コマンドプロンプトでフォルダに移動して

1	`py -3.6 pipenv install`

を実行します。

実行すると、 Pipfile に記載されているパッケージのうちインストールされていない物があれば
インストールされます。
空の場合、指定の Python バージョンの環境構築も行われます。

なので、よく使うモジュールを設定しておいた Pipfile を用意しておけば
専用の仮想環境をコマンド１つでモジュールのインストールまで一括で
行うことができます。

VSCode と組み合わせるとより快適になるので、とても便利です。

追記¶

@echo off
; path version
mkdir %1
cd /d %1
C:\Windows\py.exe -3.6 -m pip install pipenv
C:\Windows\py.exe -3.6 -m pipenv --python %2 install
C:\Windows\py.exe -3.6 -m pipenv install pipenv

毎度プロジェクト作るときにコマンド叩くの面倒だったので、Bat を書いた。

これで

create_pipenvproj.bat D:\hogehoge 3.6 とかやるとかんたんにプロジェクトがつくれる!