RETIRED, further work has moved to Debian project infrastructure
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Corey Goldberg 8b9465c805 updated setup script with py3 classifiers 8 years ago
xvfbwrapper bumped version 8 years ago
.gitignore modified ignore files 8 years ago
MANIFEST.in Adding readme file to the source distribution, so that the pip installation from pypi can happen without any errors 9 years ago
README.rst updated test example 9 years ago
setup.py updated setup script with py3 classifiers 8 years ago
tox.ini added tox.ini and used Tox to verify compatibility for py27 py32 py33 pypy 8 years ago

README.rst

xvfbwrapper

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


Install xvfbwrapper from PyPI

pip install xvfbwrapper

System Requirements

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

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.

Example: Basic Usage

from xvfbwrapper import Xvfb

vdisplay = Xvfb()
vdisplay.start()

# launch stuff inside virtual display here

vdisplay.stop()

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.vdisplay.start()
        self.browser = webdriver.Firefox()

    def testUbuntuHomepage(self):
        self.browser.get('http://www.ubuntu.com')
        self.assertIn('Ubuntu', self.browser.title)

    def testGoogleHomepage(self):
        self.browser.get('http://www.google.com')
        self.assertIn('Google', self.browser.title)

    def tearDown(self):
        self.browser.quit()
        self.vdisplay.stop()


if __name__ == '__main__':
    unittest.main(verbosity=2)

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