dh_virtualenv1

Deploy a python package in a self-contained virtualenv

Usage

dh_virtualenv [OPTIONS]

Overview

dh-virtualenv is a tool that aims to combine Debian packaging with self-contained virtualenv based Python deployments. To do this, the package extends debhelper's sequence by providing a new command in sequence, dh_virtualenv, which effectively replaces following commands from the sequence:

`•`	`dh_auto_install`
`•`	`dh_python2`
`•`	`dh_pycentral`
`•`	`dh_pysupport`

In the sequence the dh_virtualenv is inserted right after dh_perl.

Options

`-p PACKAGE, --package=PACKAGE`	Act on the package named PACKAGE
`-N PACKAGE, --no-package=PACKAGE`	Do not act on the specified PACKAGE

-v, --verbose: Turn on verbose mode.

--extra-index-url: Pass extra index URL to pip

--preinstall=PACKAGE: Preinstall a PACKAGE before running pip.

--pip-tool=PIP_TOOL: Tool used to install requirements.

--extra-pip-arg: Extra arg for the pip executable.

--extra-virtualenv-arg: Extra arg for the virtualenv executable.

--index-url: Base URL for PyPI server.

--setuptools: Use setuptools instead of distribute.

--install-suffix=SUFFIX: Override virtualenv installation suffix

--upgrade-pip: Force upgrade pip in virtualenv

--requirements=FILE: Use FILE for requirements

--setuptools-test: Run setup.py test upon build.

--python=PATH: Use Python interpreter at PATH

--builtin-venv: Use built-in venv of Python 3

--skip-install: Don't run pip install .

Quick guide for maintainers

`1.`	Build depend on python or python-all and dh-virtualenv
`2.`	Add ${python:Depends} to Depends
`3.`	Add python-virtualenv to dh's --with option

Releases

6 releases since Debian 8 (Jessie); the text changed 5 times.

--builtin-venv since Debian 9 (Stretch); --extra-pip-arg since Debian 9 (Stretch); --extra-virtualenv-arg since Debian 9 (Stretch); --index-url since Debian 9 (Stretch); --install-suffix since Debian 9 (Stretch); --pip-tool since Debian 9 (Stretch); --python since Debian 9 (Stretch); --requirements since Debian 9 (Stretch); --setuptools-test since Debian 9 (Stretch); --skip-install since Debian 9 (Stretch); --upgrade-pip since Debian 10 (Buster).

--pypi-url until Debian 8 (Jessie); --upgrage-pip until Debian 9 (Stretch).