python-packages-in-virtualenv

Description

Installs Python packages into a Virtualenv.

Don't use this directly (in most cases), just use the 'python-virtualenv' frecklet instead, because this frecklet does not create that virtualenv, nor does it ensure that Python is available at all.

Variables

Name Type Default Description

venv_name

string --

The name of the virtualenv to set up. Required

pip_extra_args

string --

Extra arguments forwarded to 'pip'.

python_packages

list []

All necessary Python packages.

python_type

string pyenv

How to install Python. Defaults to 'pyenv'.

python_version

string latest

The version of python.

system_dependencies

list []

System packages the application depends on.

update

boolean False

Update packages if already installed.

user

string --

The user who owns/runs the virtualenv.

venv_base_path

string --

The path that holds the virtualenv directory.

venv_python_exe

string --

This only works in combination with the 'system' 'python_install_type', if used with another type, this task will fail.

Command-line

frecklecute python-packages-in-virtualenv --help

Usage: frecklecute python-packages-in-virtualenv [OPTIONS]

  Installs Python packages into a Virtualenv.

  Don't use this directly (in most cases), just use the 'python-virtualenv'
  frecklet instead, because this frecklet does not create that virtualenv,
  nor does it ensure that Python is available at all.

Options:
  --venv-name VENV_NAME           The name of the virtualenv to set up.
                                  [required]
  --pip-extra-args PIP_EXTRA_ARGS
                                  Extra arguments forwarded to 'pip'.
  -p, --python-pkg PYTHON_PACKAGES
                                  All necessary Python packages.
  --python-type PYTHON_TYPE       How to install Python. Defaults to 'pyenv'.
  --python-version PYTHON_VERSION
                                  The version of python.
  -s, --system-dependency SYSTEM_DEPENDENCIES
                                  System packages the application depends on.
  --update                        Update packages if already installed.
  --user USER                     The user who owns/runs the virtualenv.
  --venv-base-path VENV_BASE_PATH
                                  The path that holds the virtualenv
                                  directory.
  --venv-python-exe VENV_PYTHON_EXE
                                  The (optional) path to an existing Python
                                  executable to be used for the venv.
  --help                          Show this message and exit.