Installing Python modules

As a popular open source development project, Python has an active supporting community of contributors and users that also make their software available for other Python developers to use under open-source license terms.

これにより、Python ユーザーは効果的に共有や協力を行えます。 よくある問題 (ときには珍しい問題も!) に対してほかの人がすでに作った解決策を活用でき、自分の解決策を共有して貢献することもできます。

このガイドはこれらプロセスのうち、インストールについてをカバーします。あなた自身の Python プロジェクトを作成し、共有するためのガイドについては Python packaging user guide を参照してください。

注釈

あなたが企業や組織のユーザであれば、多くの組織がオープンソースソフトウェアの利用と貢献に関する彼ら独自のポリシーを持っていることに気をつけてください。Python によって提供される配布とインストールのツールを利用する際には、そのようなポリシーを考慮に入れてください。

重要用語集

  • pip is the preferred installer program. It is included by default with the Python binary installers.

  • 仮想環境 は、システム全体にインストールするのではなく、特定のアプリケーションで使用するためにパッケージをインストールできるようにする半独立型のPython環境です。

  • venv is the standard tool for creating virtual environments. It defaults to installing pip into all created virtual environments.

  • virtualenv is a third-party alternative (and predecessor) to venv.

  • The Python Package Index (PyPI) is a public repository of open source licensed packages made available for use by other Python users.

  • The Python Packaging Authority is the group of developers and documentation authors responsible for the maintenance and evolution of the standard packaging tools and the associated metadata and file format standards. They maintain a variety of tools, documentation, and issue trackers on GitHub.

バージョン 3.5 で変更: 仮想環境の作成には、 venv の使用が今は推奨されています。

基本的な使い方

パッケージングのための標準ツールはすべてコマンドラインから使われることを想定しています。

The following command will install the latest version of a module and its dependencies from PyPI:

python -m pip install SomePackage

注釈

POSIX ユーザ(macOS と Linux ユーザを含みます)向けには、このガイド内の例は、 virtual environment の利用を前提にしています。

Windows ユーザ向けには、このガイド内の例は、Python インストール時にシステムの PATH 環境変数が調整されていることを前提にしています。

正確なバージョンや最小のバージョンをコマンドライン上で直接指定することもできます。> や < などの比較演算子など、シェルが解釈する特殊文字を使う場合、パッケージ名とバージョンを二重引用符で囲んでください:

python -m pip install SomePackage==1.0.4    # 特定のバージョン
python -m pip install "SomePackage>=1.0.4"  # 最小バージョンを指定

通常、適合するモジュールがインストール済である場合にそれを再度 install 実行を試みても効果はありません。既に存在しているモジュールのアップグレードには、明示的にそれを要求しなければなりません:

python -m pip install --upgrade SomePackage

More information and resources regarding pip and its capabilities can be found in the Python Packaging User Guide.

仮想環境は venv モジュールを使って作成します。 有効化した仮想環境にパッケージをインストールするには、上記のコマンドを使います。

どうすればいいの...?

以下はよくある課題への簡単な回答もしくは回答へのリンクです。

... パッケージを現在のユーザ用のみにインストールするには?

python -m pip install に --user オプションを付けてください。パッケージはシステムのすべてのユーザ用にではなく、現在のユーザ用のみにインストールされます。

... 科学技術計算用の Python パッケージをインストールするには?

A number of scientific Python packages have complex binary dependencies, and aren't currently easy to install using pip directly. It will often be easier for users to install these packages by other means rather than attempting to install them with pip.

... インストールされた複数のバージョンの Python を並行して使うには?

On Linux, macOS, and other POSIX systems, use the versioned Python commands in combination with the -m switch to run the appropriate copy of pip:

python3    -m pip install SomePackage  # default Python 3
python3.14 -m pip install SomePackage  # specifically Python 3.14

Appropriately versioned pip commands may also be available.

On Windows, use the py Python launcher in combination with the -m switch:

py -3    -m pip install SomePackage  # default Python 3
py -3.14 -m pip install SomePackage  # specifically Python 3.14

よくあるインストールに関する問題

Linux で、システムの Python 内にインストールする

On Linux systems, a Python installation will typically be included as part of the distribution. Installing into this Python installation requires root access to the system, and may interfere with the operation of the system package manager and other components of the system if a component is unexpectedly upgraded using pip.

On such systems, it is often better to use a virtual environment or a per-user installation when installing packages with pip.

pip がインストールされていない

It is possible that pip does not get installed by default. One potential fix is:

python -m ensurepip --default-pip

There are also additional resources for installing pip.

バイナリの拡張のインストール

Python once relied heavily on source-based distribution, with end users being expected to compile extension modules from source as part of the installation process.

With the introduction of the binary wheel format, and the ability to publish wheels through PyPI, this problem is diminishing, as users are more regularly able to install pre-built extensions rather than needing to build them themselves.

Some of the solutions for installing scientific software that are not yet available as pre-built wheel files may also help with obtaining other binary extensions without needing to build them locally.