以下は、Pipenv の主なコマンドを一覧形式でまとめたものです。各コマンドは、Pipenv を使ってパッケージ管理と仮想環境の操作を行うための基本的なものとなっています。
インストール/アンインストール/ロック関連
-
pipenv install [package]
→ 指定したパッケージを仮想環境にインストールし、Pipfile
に追加します。
※オプション例-
--dev
… 開発用パッケージとしてインストール([dev-packages]
に追加) -
--python <version/path>
… 特定の Python バージョンを用いて環境を作成
-
-
pipenv uninstall [package]
→ 指定したパッケージをアンインストールし、Pipfile
およびPipfile.lock
から削除します。
※オプション例-
--all
… 仮想環境内のすべてのパッケージを削除(Pipfile
はそのまま残る) -
--all-dev
… 開発用パッケージのみを削除
-
-
pipenv lock
→Pipfile
の内容に基づいてPipfile.lock
を生成または更新します。
※※ロックファイルによる依存関係の決定論的(再現可能な)環境構築を実現 -
pipenv sync
→ 既にロックされたPipfile.lock
の内容に従い、仮想環境を正確に再現するために依存関係をインストールします。
※デプロイ時など、確実な環境再現が必要な際に有用 -
pipenv update [package]
→ 特定のパッケージ(または全パッケージ)の依存関係を、最新の解決版に更新します。 -
pipenv upgrade [package]
→ 環境内の特定パッケージのロック状態を更新します(更新したパッケージを環境に反映する)。
仮想環境操作/コマンド実行
-
pipenv run
→ 仮想環境内で任意のコマンドを実行します。
例:pipenv run python
やpipenv run pip freeze
-
pipenv shell
→ 仮想環境のシェルを起動します。アクティブな仮想環境内で操作を行いたい場合に使用します。 -
pipenv --venv
→ 現在使用している仮想環境のパスを表示します。 -
pipenv --rm
→ 対象プロジェクトの仮想環境を削除します。新たに環境を作り直す場合などに便利です。
その他の補助的なコマンド
-
pipenv graph
→ インストールされているパッケージの依存関係ツリーをグラフ形式で表示します。
依存関係の全体像を把握するのに役立ちます。 -
pipenv check
→ インストール済みパッケージに対して、セキュリティの脆弱性や PEP 508 の要求が満たされているかをチェックします。 -
pipenv scripts
→Pipfile
内の[scripts]
セクションで定義したスクリプト一覧を表示します。
※これにより、定義済みのコマンドショートカットを確認できます。
補足
-
オプションの活用例
例えば、pipenv install --dev flask
のようにすれば Flask を開発用の依存関係として追加できます。
また、pipenv install --python 3.9
とすることで、指定バージョンの Python を用いた仮想環境を作成します。 -
実行例
- プロジェクトディレクトリで環境初期化
pipenv --python 3.9
- パッケージのインストール
pipenv install requests
- 仮想環境に入る
pipenv shell
- 環境内で実行
pipenv run python -m pip freeze
- 依存関係のグラフ表示
pipenv graph
- プロジェクトディレクトリで環境初期化
これらのコマンドを組み合わせることで、Pipenv を利用した依存関係管理と仮想環境の操作が容易になり、プロジェクト固有の環境構築をシンプルかつ再現性のあるものにできます。