RETIRED, further work has moved to Debian project infrastructure
Go to file
Corey Goldberg 9b023cf4e2 updated README 2012-11-18 12:17:57 -05:00
xvfbwrapper added __init__ for packaging 2012-11-18 09:37:33 -05:00
README.rst updated README 2012-11-18 12:17:57 -05:00 added setup file 2012-11-18 09:36:28 -05:00



Python wrapper for running a display inside X virtual framebuffer (Xvfb)

Install xvfbwrapper from PyPI

pip install xvfbwrapper

About Xvfb (X Virtual Framebuffer)

In the X Window System, Xvfb or X virtual framebuffer is an X11 server that performs all graphical operations in memory, not showing any screen output. This virtual server does not require the computer it is running on to even have a screen or any input device. Only a network layer is necessary.

System Requirements

  • Xvfb (sudo apt-get install xvfb, or similar)
  • Python 2

Example: Basic Usage

from xvfbwrapper import Xvfb

vdisplay = Xvfb()

# launch stuff inside virtual display here


Example: Headless Selenium WebDriver Tests

#!/usr/bin/env python

from selenium import webdriver
from xvfbwrapper import Xvfb

import unittest

class TestHomepages(unittest.TestCase):
    def setUp(self):
        self.vdisplay = Xvfb(width=1280, height=720)
        self.browser = webdriver.Firefox()

    def testUbuntuHomepage(self):
        self.assertIn('Ubuntu', self.browser.title)

    def testGoogleHomepage(self):
        self.assertIn('Google', self.browser.title)

    def tearDown(self):

if __name__ == '__main__':

This code uses selenium and xvfbwrapper to run a test with Firefox inside a Headless display.

  • install selenium bindings: pip install selenium
  • Firefox will launch inside virtual display (headless)
  • browser is not shown while tests are run