Skip to content

Latest commit

 

History

History
235 lines (165 loc) · 6.8 KB

pip_download.rst

File metadata and controls

235 lines (165 loc) · 6.8 KB

pip download

Usage

.. tab:: Unix/macOS

   .. pip-command-usage:: download "python -m pip"

.. tab:: Windows

   .. pip-command-usage:: download "py -m pip"


Description

.. pip-command-description:: download

Overview

pip download does the same resolution and downloading as pip install, but instead of installing the dependencies, it collects the downloaded distributions into the directory provided (defaulting to the current directory). This directory can later be passed as the value to pip install --find-links to facilitate offline or locked down package installation.

pip download with the --platform, --python-version, --implementation, and --abi options provides the ability to fetch dependencies for an interpreter and system other than the ones that pip is running on. --only-binary=:all: or --no-deps is required when using any of these options. It is important to note that these options all default to the current system/interpreter, and not to the most restrictive constraints (e.g. platform any, abi none, etc). To avoid fetching dependencies that happen to match the constraint of the current interpreter (but not your target one), it is recommended to specify all of these options if you are specifying one of them. Generic dependencies (e.g. universal wheels, or dependencies with no platform, abi, or implementation constraints) will still match an over- constrained download requirement. If some of your dependencies are not available as binaries, you can build them manually for your target platform and let pip download know where to find them using --find-links.

Note

To determine the appropriate values for --python-version and --platform, you can query the target system using the following commands:

  • For the Python version, use :func:`sysconfig.get_python_version() <sysconfig.get_python_version>`.
  • For the platform, use :func:`packaging.tags.platform_tags() <packaging.tags.platform_tags>`.

Options

.. pip-command-options:: download

.. pip-index-options:: download

.. pip-package-selection-options:: download


Examples

  1. Download a package and all of its dependencies

    .. tab:: Unix/macOS
    
       .. code-block:: shell
    
          python -m pip download SomePackage
          python -m pip download -d . SomePackage  # equivalent to above
          python -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
    
    
    .. tab:: Windows
    
       .. code-block:: shell
    
          py -m pip download SomePackage
          py -m pip download -d . SomePackage  # equivalent to above
          py -m pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage
    
    
    
  2. Download a package and all of its dependencies with OSX specific interpreter constraints. This forces OSX 10.10 or lower compatibility. Since OSX deps are forward compatible, this will also match macosx_10_9_x86_64, macosx_10_8_x86_64, macosx_10_8_intel, etc. It will also match deps with platform any. Also force the interpreter version to 27 (or more generic, i.e. 2) and implementation to cp (or more generic, i.e. py).

    .. tab:: Unix/macOS
    
       .. code-block:: shell
    
          python -m pip download \
             --only-binary=:all: \
             --platform macosx_10_10_x86_64 \
             --python-version 27 \
             --implementation cp \
             SomePackage
    
    
    .. tab:: Windows
    
       .. code-block:: shell
    
          py -m pip download ^
             --only-binary=:all: ^
             --platform macosx_10_10_x86_64 ^
             --python-version 27 ^
             --implementation cp ^
             SomePackage
    
    
  3. Download a package and its dependencies with linux specific constraints. Force the interpreter to be any minor version of py3k, and only accept cp34m or none as the abi.

    .. tab:: Unix/macOS
    
       .. code-block:: shell
    
          python -m pip download \
             --only-binary=:all: \
             --platform linux_x86_64 \
             --python-version 3 \
             --implementation cp \
             --abi cp34m \
             SomePackage
    
    
    .. tab:: Windows
    
       .. code-block:: shell
    
          py -m pip download ^
             --only-binary=:all: ^
             --platform linux_x86_64 ^
             --python-version 3 ^
             --implementation cp ^
             --abi cp34m ^
             SomePackage
    
    
  4. Force platform, implementation, and abi agnostic deps.

    .. tab:: Unix/macOS
    
       .. code-block:: shell
    
          python -m pip download \
             --only-binary=:all: \
             --platform any \
             --python-version 3 \
             --implementation py \
             --abi none \
             SomePackage
    
    
    .. tab:: Windows
    
       .. code-block:: shell
    
          py -m pip download ^
             --only-binary=:all: ^
             --platform any ^
             --python-version 3 ^
             --implementation py ^
             --abi none ^
             SomePackage
    
    
  5. Even when overconstrained, this will still correctly fetch the pip universal wheel.

    .. tab:: Unix/macOS
    
       .. code-block:: console
    
          $ python -m pip download \
             --only-binary=:all: \
             --platform linux_x86_64 \
             --python-version 33 \
             --implementation cp \
             --abi cp34m \
             pip>=8
    
       .. code-block:: console
    
          $ ls pip-8.1.1-py2.py3-none-any.whl
          pip-8.1.1-py2.py3-none-any.whl
    
    
    .. tab:: Windows
    
       .. code-block:: console
    
          C:\> py -m pip download ^
             --only-binary=:all: ^
             --platform linux_x86_64 ^
             --python-version 33 ^
             --implementation cp ^
             --abi cp34m ^
             pip>=8
    
       .. code-block:: console
    
          C:\> dir pip-8.1.1-py2.py3-none-any.whl
          pip-8.1.1-py2.py3-none-any.whl
    
    
  6. Download a package supporting one of several ABIs and platforms. This is useful when fetching wheels for a well-defined interpreter, whose supported ABIs and platforms are known and fixed, different than the one pip is running under.

    .. tab:: Unix/macOS
    
       .. code-block:: console
    
          $ python -m pip download \
             --only-binary=:all: \
             --platform manylinux1_x86_64 --platform linux_x86_64 --platform any \
             --python-version 36 \
             --implementation cp \
             --abi cp36m --abi cp36 --abi abi3 --abi none \
             SomePackage
    
    
    .. tab:: Windows
    
       .. code-block:: console
    
          C:> py -m pip download ^
             --only-binary=:all: ^
             --platform manylinux1_x86_64 --platform linux_x86_64 --platform any ^
             --python-version 36 ^
             --implementation cp ^
             --abi cp36m --abi cp36 --abi abi3 --abi none ^
             SomePackage