pip wheel

使用法

Unix/macOS

python -m pip wheel [options] <requirement specifier> ...
python -m pip wheel [options] -r <requirements file> ...
python -m pip wheel [options] [-e] <vcs project url> ...
python -m pip wheel [options] [-e] <local project path> ...
python -m pip wheel [options] <archive url/path> ...

Windows

py -m pip wheel [options] <requirement specifier> ...
py -m pip wheel [options] -r <requirements file> ...
py -m pip wheel [options] [-e] <vcs project url> ...
py -m pip wheel [options] [-e] <local project path> ...
py -m pip wheel [options] <archive url/path> ...

説明

要件と依存関係のためのWheelアーカイブを構築します。

Wheelはビルド済みのパッケージ形式であり、インストールごとにソフトウェアを再コンパイルしないという利点があります。詳細については、wheelのドキュメントを参照してください: https://wheel.readthedocs.io/en/latest/

「pip wheel」は、ここに記載されているように、ビルドシステムインターフェースを使用します: https://pip.dokyumento.jp/en/stable/reference/build-system/

ビルドシステムインターフェース

これは現在、ビルドシステムインターフェースでカバーされています。

buildとの違い

build は、とりわけ、標準の pyproject.toml ベースのビルドインターフェースを使用してプロジェクトのホイールをビルドできるシンプルなツールです。これは、pip wheel --no-deps . の実行に匹敵します。また、pip では不可能なソースディストリビューションをビルドすることもできます。pip wheel は、build のホイールスコープをカバーしていますが、多くの追加機能を提供します。

オプション

-w, --wheel-dir <dir>

ホイールを <dir> にビルドします。デフォルトは現在の作業ディレクトリです。

(環境変数: PIP_WHEEL_DIR)

--no-binary <format_control>

バイナリパッケージを使用しません。複数回指定でき、そのたびに既存の値に追加されます。「:all:」を指定すると、すべてのバイナリパッケージが無効になり、「:none:」を指定するとセットが空になり(コロンに注意)、またはカンマで区切られた1つ以上のパッケージ名 (コロンなし) を指定できます。一部のパッケージはコンパイルが難しく、このオプションが使用されているとインストールに失敗する可能性があることに注意してください。

(環境変数: PIP_NO_BINARY)

--only-binary <format_control>

ソースパッケージを使用しません。複数回指定でき、そのたびに既存の値に追加されます。「:all:」を指定すると、すべてのソースパッケージが無効になり、「:none:」を指定するとセットが空になり、またはカンマで区切られた1つ以上のパッケージ名を指定できます。バイナリディストリビューションのないパッケージは、このオプションを使用するとインストールに失敗します。

(環境変数: PIP_ONLY_BINARY)

--prefer-binary

ソースパッケージが新しい場合でも、ソースパッケージよりもバイナリパッケージを優先します。

(環境変数: PIP_PREFER_BINARY)

--no-build-isolation

最新のソースディストリビューションをビルドする際の分離を無効にします。このオプションを使用する場合、PEP 518で指定されたビルド依存関係は既にインストールされている必要があります。

(環境変数: PIP_NO_BUILD_ISOLATION)

--use-pep517

ソースディストリビューションのビルドにPEP 517を使用します（レガシーの動作を強制するには--no-use-pep517を使用します）。

(環境変数: PIP_USE_PEP517)

--check-build-dependencies

PEP517が使用されている場合、ビルド依存関係を確認します。

(環境変数: PIP_CHECK_BUILD_DEPENDENCIES)

-c, --constraint <file>

指定された制約ファイルを使用してバージョンを制約します。このオプションは複数回使用できます。

(環境変数: PIP_CONSTRAINT)

-e, --editable <path/url>

ローカルプロジェクトパスまたはVCS URLから、編集可能モード（つまり、setuptoolsの「開発モード」）でプロジェクトをインストールします。

(環境変数: PIP_EDITABLE)

-r, --requirement <file>

指定された要件ファイルからインストールします。このオプションは複数回使用できます。

(環境変数: PIP_REQUIREMENT)

--src <dir>

編集可能なプロジェクトをチェックアウトするディレクトリ。仮想環境でのデフォルトは「<venv path>/src」です。グローバルインストールのデフォルトは「<current dir>/src」です。

(環境変数: PIP_SRC, PIP_SOURCE, PIP_SOURCE_DIR, PIP_SOURCE_DIRECTORY)

--ignore-requires-python

Requires-Python情報を無視します。

(環境変数: PIP_IGNORE_REQUIRES_PYTHON)

--no-deps

パッケージの依存関係をインストールしません。

(環境変数: PIP_NO_DEPS, PIP_NO_DEPENDENCIES)

--progress-bar <progress_bar>

プログレスバーを使用するかどうかを指定します [on, off, raw] (デフォルト: on)

(環境変数: PIP_PROGRESS_BAR)

--no-verify

ビルドされた wheel が有効かどうかを検証しません。

(環境変数: PIP_NO_VERIFY)

-C, --config-settings <settings>

PEP 517 ビルドバックエンドに渡される構成設定。設定は KEY=VALUE の形式を取ります。複数のキーをバックエンドに渡すには、複数の --config-settings オプションを使用します。

(環境変数: PIP_CONFIG_SETTINGS)

--build-option <options>

'setup.py bdist_wheel' に渡される追加の引数。

(環境変数: PIP_BUILD_OPTION)

--global-option <options>

インストールまたは bdist_wheel コマンドの前に、setup.py 呼び出しに渡される追加のグローバルオプション。

(環境変数: PIP_GLOBAL_OPTION)

--pre

プレリリース版および開発版を含めます。デフォルトでは、pip は安定版のみを検索します。

(環境変数: PIP_PRE)

--require-hashes

反復可能なインストールのため、各要件をチェックするためのハッシュを要求します。このオプションは、requirements ファイル内の任意のパッケージに --hash オプションがある場合に暗黙的に指定されます。

(環境変数: PIP_REQUIRE_HASHES)

--no-clean

ビルドディレクトリをクリーンアップしません。

(環境変数: PIP_NO_CLEAN)

-i, --index-url <url>

Python Package Index のベース URL (デフォルト https://pypi.org/simple)。これは、PEP 503 (simple repository API) に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを指している必要があります。

(環境変数: PIP_INDEX_URL, PIP_PYPI_URL)

--extra-index-url <url>

--index-url に加えて使用するパッケージインデックスの追加 URL。--index-url と同じルールに従う必要があります。

(環境変数: PIP_EXTRA_INDEX_URL)

--no-index

パッケージインデックスを無視します (--find-links の URL のみを参照)。

(環境変数: PIP_NO_INDEX)

-f, --find-links <url>

HTML ファイルへの URL またはパスの場合、sdist (.tar.gz) または wheel (.whl) ファイルなどのアーカイブへのリンクを解析します。ローカルパスまたは file:// URL がディレクトリの場合は、ディレクトリリストでアーカイブを検索します。VCS プロジェクト URL へのリンクはサポートされていません。

(環境変数: PIP_FIND_LINKS)

例

1. 要件 (およびそのすべての依存関係) の wheel をビルドし、インストールします。

   Unix/macOS

   python -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
   python -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
   

   Windows

   py -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
   py -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
   

2. ソースからパッケージの wheel をビルドします。

   Unix/macOS

   python -m pip wheel --no-binary SomePackage SomePackage
   

   Windows

   py -m pip wheel --no-binary SomePackage SomePackage