Page History

Python VirtualEnv action is used to create a virtual environment for python.

Pip Wheel

Image Removed

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 build the wheel for. 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 see 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]

Output Directory

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

Path to the directory where the wheel will be built. Defaults to the working folder. [--wheel]

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.

It should used as a parent action. Child actions of this action will run under the activated virtual environment. The virtual environment will be deactivated once all child actions are completed.

Python VirtualEnv

Image Added

Target Directory

The path to the directory where the virtual environment is created.

Extra Search Directories

Directories to look in for your own versions of setuptools / pip distributions to use instead of the embedded versions that come with virtualenv. One path per line. [--extra-search-directories]

Python Interpreter

The path to the Python interpreter to use. Leave blank to use the interpreter that virtualenv was installed with. [--python]

Install VirtualEnv on agent using Pip

If this is ticked, VirtualEnv is installed on the agent using Pip. A new tab appears for entering Pip settingsIf 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 Python VirtualEnv action. The pattern for this action is ^Python.VirtualEnv\..*. The default property collector searches the environment path for "virtualenv.exe".

...

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.

...

Pip

Image Removed

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]

Connection

Image 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]

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]

Installation

Image Removed

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-clean]

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]

Package Index

Image Removed

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 URL

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

Image Removed

Global Options

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

Options

Image Removed

Image Added

Use an alternate source to PyPI to install VirtualEnv

If this is ticked, PyPI is not used as a source to install VirtualEnv.

Package Source

The VirtualEnv package source to use for the install.

Install project in editable mode

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

Source Directory

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

The directory to check out editable projects into. The default is “<current dir>\src”.

Install pre-release or development package version

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

Disable cache

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

Pip Verbosity

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

Using Pip

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

Image Added

Do not install pip in the new virtual environment.

If this is ticked, pip is not installed in the new virtual environment. [--no-pip]

Do not install wheel in the new virtual environment.

If this is ticked, wheel is not installed in the new virtual environment. [--no-wheel]

Do not install setuptools in the new virtual environment.

If this is ticked, setuptools is not installed in the new virtual environment. [--no-setuptools]

Unzip setuptools when installing it.

Visible only if the checkbox 'Do not install setuptools in the new virtual environment' is NOT ticked.

If this is ticked, setuptools is unzipped when installing it. [--unzip-setuptools]

Preinstalled PyPI Packages

Select whether to download preinstalled packages from PyPI. [--download | --no-download]

Clear out the non-root install and start from scratch.

Tick to clear out the non-root install and start from scratch. [--clear]

Give the virtual environment access to the global site-packages.

If this is ticked, the virtual environment is given access to the global site-packages. [--system-site-packages]

Always copy files rather than symlinking.

If this is ticked, files are always copied rather than symlinking. [--always-copy]

Options

Image Added

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]

–quiet | -verbose]

Remove virtual environment upon completion

...

.

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

Cache Directory

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]

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.

virtual environment directory is deleted upon completion.

Timeout (in seconds) 

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

...

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

Environment

Image RemovedImage Added

Environment Variables

...