testing/mozbase/docs/mozinstall.rst

   1 :mod:`mozinstall` --- Install and uninstall Gecko-based applications
   2 ====================================================================
   3
   4 mozinstall is a small python module with several convenience methods
   5 useful for installing and uninstalling a gecko-based application
   6 (e.g. Firefox) on the desktop.
   7
   8 Simple example
   9 --------------
  10
  11 ::
  12
  13     import mozinstall
  14     import tempfile
  15
  16     tempdir = tempfile.mkdtemp()
  17     firefox_dmg = 'firefox-38.0a1.en-US.mac.dmg'
  18     install_folder = mozinstall.install(src=firefox_dmg, dest=tempdir)
  19     binary = mozinstall.get_binary(install_folder, 'Firefox')
  20     # from here you can execute the binary directly
  21     # ...
  22     mozinstall.uninstall(install_folder)
  23
  24 API Documentation
  25 -----------------
  26
  27 .. automodule:: mozinstall
  28    :members: is_installer, install, get_binary, uninstall,
  29              InstallError, InvalidBinary, InvalidSource