Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Pip Wheel action is used to download python wheels to the workspacebuild Wheel archives for your requirements and dependencies.

Pip Wheel

Image RemovedImage Added

Working Folder

The working directory for the pip command line. Leave blank to default to the workspace folder.

Package To

...

Build Wheel For

The name of the Python package, the URL of the VCS project, a local project directory, or the path/URL of a local/remote package archive to installbuild the wheel for. Leave blank or '.' to search in working folder.

...

Install packages from the given requirements files. One file path per line. [--requirement]

...

Output Directory

Visible only if the checkbox 'Install the project in editable mode' is NOT ticked.

The path Path to the directory where the packages wheel will be installed. This will not replace existing files/folders, unless the Upgrade option is tickedbuilt. Defaults to the working folder. [--targetwheel]

Source Directory

Visible only if the checkbox 'Install the project in editable mode' is ticked.

...

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.


Settings

Image RemovedImage Added

Non-Binary Packages

...

If this is ticked, older binary packages will be used instead of newer source packages. [--prefer-binary]

Upgrade all specified packages to newest available version.

If this is ticked, all specified packages are upgraded to newest available version.

Upgrade Strategy

Visible only if the checkbox 'Upgrade all specified packages to newest available version' is ticked.

Determines how dependency upgrading should be handled. As of pip version 10.0, the default strategy is 'only-if-needed'. [--upgrade-strategy]

  • Only-if-needed - Dependencies are upgraded only when they do not satisfy the requirements of the upgraded package(s).
  • Eager - Dependencies are upgraded regardless of whether the currently installed version satisfies the requirements of the upgraded package(s).

Reinstall all packages even if they are already up-to-date.

Visible only if the checkbox 'Upgrade all specified packages to newest available version' is ticked.

If this is ticked, all packages are reinstalled even if they are already up-to-date. Similar process to pip uninstall -y package && pip install package. [--force-reinstall]

Ignore the installed packages (reinstalling instead).

Visible only if the checkbox 'Upgrade all specified packages to newest available version' is ticked.

If this is ticked, installed packages and its dependencies are ignored so files are overwritten. [--ignore-reinstalled]

Connection


Connection

Image AddedImage Removed

Proxy

Specify a proxy in the form [user:passwd@]proxy.server:port. It is recommended to use a password type variable to store the password. [--proxy]

...

Maximum number of retries each connection should attempt. Leave zero to default to 5 times. [--retries]

...


Installation

Image RemovedImage Added

Platform

Only use wheels compatible with specified platform (e.g. 'win32', 'linux_i386', 'linux_x86_64'). Defaults to the platform of the running system. [–platform]

Implementation

Only use wheels compatible with specified Python implementation (e.g. ‘pp’, ‘jy’, ‘cp’, or ‘ip’). Defaults to the current interpreter implementation. Use ‘py’ to force implementation-agnostic wheels. [–implementation]

Python Version

Only use wheels compatible with specified Python interpreter version. If not specified, then the current system interpreter minor version is used. Either a major version (e.g. ‘3’) can be specified to match all minor revs of that major version or a minor version (e.g. ‘34’) can also be specified. [--python-version]

Python ABI

Build

Directory to unpack packages into and build in. [--build]

Source Distribution

Select whether to use PEP 517 for building source distributions or force legacy behaviour. [--use-pep517 | --no-use-pep517]

Don't install package dependencies.

If this is ticked, package dependencies are not installed. [--no-deps]

Disable isolation when building a modern source distribution. 

If this is ticked, isolation is disabled when building a modern source distribution. [--no-build-isolation]

Don't clean up build directories.

If this is ticked, build directories are not cleaned. [--no-cleanOnly use wheels compatible with specified Python ABI (e.g. ‘pypy_41’). Defaults to the current interpreter ABI tag. Generally you will need to specify --implementation, --platform and --python-version when using this option. [--abi]

Ignore the Requires-Python information.

...

If this is ticked, pip will also find pre-release and development versions. By default, pip only finds stable versions. [--pre]

Installation

Image Removed

Root

Install everything relative to this alternate root directory. [--root]

Prefix

Installation prefix where lib, bin and other top-level folders are placed. [--prefix]

Build

Directory to unpack packages into and build in. [--build]

Install to the Python user install directory for your platform Typically in %APPDATA%\Python.

If this is ticked, the packages will be installed to the python user install directory for your platform. Typically in %APPDATA%\Python. [--user]

Source Distribution

Select whether to use PEP 517 for building source distributions or force legacy behaviour. [--use-pep517 | --no-use-pep517]

...

Select whether or not to compile Python source files to bytecode. [--compile | --no-compile]

Don't install package dependencies.

If this is ticked, package dependencies are not installed. [--no-deps]

Disable isolation when building a modern source distribution. 

If this is ticked, isolation is disabled when building a modern source distribution. [--no-build-isolation]

Don't clean up build directories.

If this is ticked, build directories are not cleaned. [--no-clean]


Package Index

Image RemovedImage Added

No Index

If this is ticked, the package index is ignored. Only look at find links URLs instead.

...

If a URL or path to a HTML file is specified, then it is parsed for links to archives. If a local path or file:// URL that’s a directory is specified, then the directory listing will be searched for archives. [--find-links]


Extra Arguments

Image RemovedImage Added

Global Options

Extra global options to be supplied to the setup.py call before the install command. One per line. [--global-option]

...


Options

Extra arguments to be supplied to the setup.py install command. One per line. [--install-option]

Options

Image RemovedImage Added

Verbosity

The amount of information detail to display in the build log. [-qqq | -qq | -q | -v]

...

If this ticked, pip is run in an isolated mode, ignoring environment variables and user configuration. [--isolated]

Do not warn when installing scripts outside PATH.

If this is ticked, there is no warning when installing scripts outside PATH. [--no-warn-script-location]

Do not warn about broken dependencies.

If this is ticked, there is no warning about broken dependencies. [--no-warn-conflicts]

Exists Action

Specify what to do if path already exists. [--exists-action]

...

If this is ticked, any warnings logged will not mark the action with a warning status.


Environment

Image RemovedImage Added

Environment Variables

...