summaryrefslogtreecommitdiffstats
path: root/testing/mozbase/docs/mozinstall.rst
diff options
context:
space:
mode:
Diffstat (limited to 'testing/mozbase/docs/mozinstall.rst')
-rw-r--r--testing/mozbase/docs/mozinstall.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/testing/mozbase/docs/mozinstall.rst b/testing/mozbase/docs/mozinstall.rst
new file mode 100644
index 000000000..7db40d73d
--- /dev/null
+++ b/testing/mozbase/docs/mozinstall.rst
@@ -0,0 +1,29 @@
+: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