===============
    xvfbwrapper
===============

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

*************
    Requires:
*************

  * Xvfb ('sudo apt-get install xvfb' or similar)

************
    Example:
************

::
    
    from xvfbwrapper import Xvfb

    vdisplay = Xvfb()
    vdisplay.start()
    
    # launch stuff inside virtual display here

    vdisplay.stop()

*****************************************************
    Example: Headless Selenium WebDriver and Firefox:
*****************************************************

  * Firefox will launch inside virtual display (headless)
  * browser is not shown while test is run

::

    from xvfbwrapper import Xvfb

    import unittest
    from selenium import webdriver


    class TestUbuntuHomepage(unittest.TestCase):
        def setUp(self):
            self.vdisplay = Xvfb(width=1280, height=720)
            self.vdisplay.start()
            self.browser = webdriver.Firefox()
            
        def testTitle(self):
            self.browser.get('http://www.ubuntu.com')
            self.assertIn('Ubuntu', self.browser.title)
            
        def tearDown(self):
            self.browser.quit()
            self.vdisplay.stop()


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

************************************************
    pip install latest dev branch from git repo:
************************************************

::

    pip install -e git+http://github.com/cgoldberg/xvfbwrapper.git#egg=xvfbwrapper