testing/mozbase/docs/mozinstall.rst
author Masayuki Nakano <masayuki@d-toybox.com>
Thu, 19 Feb 2015 15:50:19 +0900
changeset 229844 d7ef5a56b661bbabc20b0ef5ba09e5e8d3b9cba0
parent 229555 d979b7a7ed9c1f3c323ebf2357b98c96eeca0f18
permissions -rw-r--r--
Bug 1119609 part.3 Implement converting methods from key/code value to key/code name index r=smaug

:mod:`mozinstall` --- Install and uninstall Gecko-based applications
====================================================================

mozinstall is a small python module with several convenience methods
useful for installing and uninstalling a gecko-based application
(e.g. Firefox) on the desktop.

Simple example
--------------

::

    import mozinstall
    import tempfile

    tempdir = tempfile.mkdtemp()
    firefox_dmg = 'firefox-38.0a1.en-US.mac.dmg'
    install_folder = mozinstall.install(src=firefox_dmg, dest=tempdir)
    binary = mozinstall.get_binary(install_folder, 'Firefox')
    # from here you can execute the binary directly
    # ...
    mozinstall.uninstall(install_folder)

API Documentation
-----------------

.. automodule:: mozinstall
   :members: is_installer, install, get_binary, uninstall,
             InstallError, InvalidBinary, InvalidSource