最低限のpipenvの使い方

最低限のpipenvの使い方

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

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

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

pipenvのインストール方法

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

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

よく利用するpipenvコマンド

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

# 仮想環境の作成(3.8の環境を作成する場合)
$ pipenv --python 3.8
# virtualenv環境の削除
$ pipenv --rm
# パッケージのインストール
$ pipenv install <package>
# 開発用にだけパッケージをインストールする場合
$ pipenv install --dev <pacakge>
# パッケージの削除
$ pipenv uninstall <package>
# pipenvコマンドを利用したmain.pyの実行
$ pipenv run python main.py
# 仮想環境へ入る
$ pipenv shell
# Pipfileから仮想環境を作成する。最新のパッケージが入る
$ pipenv install
# Pipfile.lockから仮想環境を作成する。.lockと同じバージョンのパッケージが入る
$ pipenv sync
# パッケージ間の依存関係を表示
$ pipenv graph

便利な小技

スクリプトの登録

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

# [scripts]を追加する
$ vim Pipfile
...
[scripts]
main = "python main.py"
# 追加したコマンドで実行
# 下記は、pipenv run python main.pyと同じ
$ pipenv run main

環境変数の管理

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

$ cat .env
VAR_ENV=varenv

仮想環境の場所

pipenvで作成した仮想環境が保存されるディレクトリです。下記はubuntu20.04を利用しているときのデフォルトの保存先です。

vscodeでpythonの実行環境を指定するときに、仮想環境のパスが必要になりますよね。

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