Pip Install Action

Pip Install

Working Folder

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

Package To Install

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 install. Leave blank or '.' to search in working folder.

Note that if installing a VCS project in editable mode it must be in the form: vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir. (e.g git+http://git.example.com/MyProject#egg=MyProject). For more information please refer to Pip Install VCS Support.

Install the project in editable mode

If this is ticked, the project is installed in editable mode.

Requirements File(s)

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

Target Directory

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

The path to the directory where the packages will be installed. This will not replace existing files/folders, unless the Upgrade option is ticked. [---target]

Source Directory

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

The directory to check out editable projects into. The default when running under a virtual environment is “<venv path>\src”. The default for global installs is “<current dir>\src”. [---src]

Use command line executable in virtual environment scripts folder if it exists.

If this is ticked and exists, the pip executable in the virtual environment scripts folder will be used instead.

Using

The Using drop down is populated by any property collector properties whose namespace matches the pattern defined by the Pip Install action. The pattern for this action is ^Pip\..*. The default property collector searches the environment path for "pip.exe".

If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "Pip".

For more in-depth explanations on property collectors see Property Collectors.

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

Non-Binary Packages

Specify any packages for which binary packages should not be used. [---no-binary]

• All - Disable all binary packages.
• None - Empty the set of binary packages to be disabled.
• Custom List - The custom set of binary packages to be disabled.

Note that some packages are tricky to compile and may fail to install when this option is used on them.

Non-Binary Package Names

Visible only if the option 'Custom List' is selected.

The names of the non-binary packages. One per line.

Binary Only Packages

Specify any packages for which only binary packages should not be used. [---only-binary]

• All - Disable all source packages.
• None - Empty the set of source packages to be disabled.
• Custom List - The custom set of source packages to be disabled.

Note that packages without binary distributions will fail to install when this option is used on them.

Binary Only Package Names

Visible only if the option 'Custom List' is selected.

The names of the non-binary packages. One per line.

Constraints File(s)

Constrain versions using the given constraints files. One file path per line. [---constraint]

Prefer older binary packages over newer source 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.

If this is ticked, all packages are reinstalled even if they are already up-to-date. [---force-reinstall]

Connection

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]

Trusted Host

Mark this host as trusted even if it does not have valid or any HTTPS. [---trusted-host]

CA Certificate

The path to the alternate CA bundle. [---cert]

Client Certificate

The path to the SSL client certificate. A single file containing the private key and the certificate in PEM format. [---client-cert]

Timeout

Set the socket timeout in seconds. Leave zero to default to 15 seconds. [---timeout]

Retires

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

Python

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

Only 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 ticked, the Requires-Python information is ignored. [---ignore-requires-python]

Require a hash to check against each requirement for repeatable installs. This is implied when any package in a requirements file has a --hash option.

If this is ticked, a hash is required to check against each requirement for repeatable installs. This is implied when any package in a requirements file has a --hash option. [---require-hashes]

Include pre-release and development versions. By default, pip only finds stable versions.

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

Installation

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.

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]

Compilation Option

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

No Index

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

Index URL

Visible only if the checkbox 'No Index' is NOT ticked.

The base URL of Python Package Index. Default is https://pypi.org/simple. This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format. [---index-url]

Extra Index URLs

Visible only if the checkbox 'No Index' is NOT ticked.

The extra URLs of package indexes to use in addition to --index-url. Should follow the same rules as --index-url. [---extra-index-url]

Find Links

Visible only if the checkbox 'No Index' is ticked.

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

Global Options

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

Install Options

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

Options

Verbosity

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

Log File

The path to a verbose appending log file. [---log]

Disable the cache.

If this is ticked, the cache is disabled. [---no-cache-dir]

Cache Directory

Visible only if the checkbox 'Disable the cache' is NOT ticked.

The path to a directory to store the cache data. [---cache-dir]

Run pip in an isolated mode, ignoring environment variables and user configuration.

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]

• Switch - Only relevant to VCS checkout. Attempt to switch the checkout to the appropriate URL and/or revision.
• Ignore - Abort current operation (e.g. don’t copy file, don’t create archive, don’t modify a checkout).
• Wipe - Delete the file or VCS checkout before trying to create, download, or checkout a new one.
• Backup - Rename the file or checkout to {name}{'.bak' * n}, where n is some number of .bak extensions, such that the file didn’t exist at some point. So the most recent backup will be the one with the largest number after .bak.
• Abort - Abort pip and return non-zero exit status.

Timeout (in seconds)

How many seconds to wait for the action to finish before timing out. The default is 86400 seconds (24 hours).

Treat failure as warning

Tick to continue build on failure marking the action with a warning status.

Ignore warnings

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

Environment

Environment Variables

Multiple environment variables can be defined - one per line. These are set before the command line is run.

Log environment variables

If this is ticked, environment variable values are written to the build log.

Generate system environment variables

Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.

Mask sensitive variable values in system environment variables

This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.

If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.