pipenvのインストールと基本的な使い方

最近、pythonの開発環境の構築のためにpipenvを利用しています。

pipenvを利用していてよく調べるコマンドや小技についてまとめたいと思います。

ほぼ自分のための備忘録。随時更新予定です。

pipenvのインストール

pipコマンドでインストールして、パスを通します。

下記はzshを利用している例です。

# インストール
$ pip3 install pipenv

# パス情報を設定ファイルに書き込み
$ echo 'export PATH=$PATH:/home/username/.local/bin' >> ~/.zshenv

# 読み込み
$ source ~/.zshenv

利用頻度の高いpipenvコマンド

pipenvでよく利用するコマンドです。

仮想環境の作成と削除

バージョンは適宜変更してください。

# 空のpipenv環境作成
$ pipenv --python 3.8

# 既に存在するPipfileからpipenv環境を作成する。パッケージのバージョンは最新が入る
$ pipenv install 

# Pipfile.lockから仮想環境を作成する。.lockと同じバージョンのパッケージが入る
$ pipenv sync

# 環境の削除
$ pipenv --rm

パッケージのインストール・削除・リスト表示など

# パッケージのインストール
$ pipenv install <package>

# 開発用にだけパッケージをインストールする場合
$ pipenv install --dev <pacakge>

# パッケージの削除
$ pipenv uninstall <package>

# パッケージ間の依存関係を表示
$ pipenv graph

仮想環境の利用方法

# pipenvコマンドを利用したmain.pyの実行
$ pipenv run python main.py

# 仮想環境へ入る
$ pipenv shell

便利な小技

スクリプトの登録

プログラムを別名で実行できるようにするためには、Pipfileに[scripts]を追加します。

$ vim Pipfile

...
[scripts]
main = "python main.py"

下記で、mainを実行

# 下記は、pipenv run python main.pyと同じ
$ pipenv run main

環境変数の管理

Pipenvではプロジェクト内の.envファイルを自動で読み込んで環境変数を設定できます。

$ cat .env
VAR_ENV=varenv

作成済み仮想環境の場所

vscodeでpythonの実行環境を指定するときに、仮想環境のパスが必要になりますが、下記がubuntu20.04を利用しているときのデフォルトの保存先です。

/home/hoge/.local/share/virtualenvs/...