Pip Install
Pip Install
Pip Install
Settings
...
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.
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]
Non-Binary Package Names
Visible only if the 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]
Binary Only Package Names
Visible only if the 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
Determines how dependency upgrading should be handled. As of pip version 10.0, the default strategy is 'only-if-needed'. [--upgrade-strategy]
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. Similar process to pip uninstall -y package && pip install package. [--force-reinstall]
Ignore the installed packages (reinstalling instead).
If this is ticked, installed packages and its dependencies are ignored so files are overwritten. [--ignore-reinstalled]
Connection
Python
Installation
...
Package Index
Extra Arguments
Options
Verbosity
The amount of information detail to display in the build log. [-verbosity=]
Dry Run
Logs the output from running the Cake action without actually performing any tasks. [-dryrun]
Experimental
Use the latest build of the Roslyn script engine. [-experimental]
Timeout (in seconds)
How many seconds to wait for the action to finish before timing out. The default is 86400 seconds (24 hours).
...