- Using dh-virtualenv
- How does it work?
- Running tests
- Building the documentation locally
- Code of conduct
dh-virtualenv is a tool that aims to combine Debian packaging with self-contained virtualenv based Python deployments.
The idea behind dh-virtualenv is to be able to combine the power of Debian packaging with the sandboxed nature of virtualenvs. In addition to this, using virtualenv enables installing requirements via Python Package Index instead of relying on the operating system provided Python packages. The only limiting factor is that you have to run the same Python interpreter as the operating system.
For complete online documentation including installation instructions, see the online documentation.
Using dh-virtualenv is fairly straightforward. First, you need to
define the requirements of your package in
requirements.txt file, in
the format defined by pip.
To build a package using dh-virtualenv, you need to add dh-virtualenv
in to your build dependencies and write following
%: dh $@ --with python-virtualenv
Note that you might need to provide additional build dependencies too, if your requirements require them.
Also, you are able to define the root path for your source directory using
%: dh $@ --with python-virtualenv --sourcedirectory=root/srv/application
NOTE: Be aware that the configuration in debian/rules expects tabs instead of spaces!
Once the package is built, you have a virtualenv contained in a Debian
package and upon installation it gets placed, by default, under
For more information and usage documentation, check the accompanying
documentation in the
doc folder, also available at
Read the Docs.
How does it work?
To do the packaging, dh-virtualenv extends debhelper's sequence by
inserting a new
dh_virtualenv command, which effectively replaces
the following commands in the original sequence:
In the new sequence,
dh_virtualenv is inserted right before
$ nosetests ./test/test_deployment.py
Building the documentation locally
If you execute the following commands in your clone of the repository,
a virtualenv with all necessary tools is created.
invoke docs then builds the documentation into
command . .env --yes --develop invoke docs
To start a watchdog that auto-rebuilds documentation and reloads the opened browser tab on any change,
invoke docs -w -b (stop the watchdog using the
Code of conduct
This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.
Copyright (c) 2013-2017 Spotify AB
dh-virtualenv is licensed under GPL v2 or later. Full license is
available in the