Metadata-Version: 1.0
Name: mozprofile
Version: 0.1
Summary: handling of Mozilla XUL app profiles
Home-page: http://github.com/mozautomation/mozmill
Author: Mozilla Automation + Testing Team
Author-email: mozmill-dev@googlegroups.com
License: MPL
Description: [Mozprofile](https://github.com/mozilla/mozbase/tree/master/mozprofile)
        is a python tool for creating and managing profiles for Mozilla's
        applications (Firefox, Thunderbird, etc.). In addition to creating profiles,
        mozprofile can install [addons](https://developer.mozilla.org/en/addons)
        and set [preferences](https://developer.mozilla.org/En/A_Brief_Guide_to_Mozilla_Preferences).  
        Mozprofile can be utilized from the command line or as an API.
        
        
        # Command Line Usage
        
        mozprofile may be used to create profiles, set preferences in
        profiles, or install addons into profiles.
        
        The profile to be operated on may be specified with the `--profile`
        switch. If a profile is not specified, one will be created in a
        temporary directory which will be echoed to the terminal:
        
            (mozmill)> mozprofile 
            /tmp/tmp4q1iEU.mozrunner
            (mozmill)> ls /tmp/tmp4q1iEU.mozrunner
            user.js
        
        To run mozprofile from the command line enter:
        `mozprofile --help` for a list of options.
        
        
        # API Usage
        
        To use mozprofile as an API you can import
        [mozprofile.profile](https://github.com/mozilla/mozbase/tree/master/mozprofile/mozprofile/profile.py)
        and/or the
        [AddonManager](https://github.com/mozilla/mozbase/tree/master/mozprofile/mozprofile/addons.py). 
        
        `mozprofile.profile` features a generic `Profile` class.  In addition,
        subclasses `FirefoxProfile` and `ThundebirdProfile` are available
        with preset preferences for those applications.
        
        
        # Installing Addons
        
        Addons may be installed individually or from a manifest.
        
        Example:
        
        	from mozprofile import FirefoxProfile
        	
        	# create new profile to pass to mozmill/mozrunner
        	profile = FirefoxProfile(addons=["adblock.xpi"])
        
        
        # Setting Preferences
        
        Preferences can be set in several ways:
        
        - using the API: You can pass preferences in to the Profile class's
          constructor: `obj = FirefoxProfile(preferences=[("accessibility.typeaheadfind.flashBar", 0)])`
        - using a JSON blob file: `mozprofile --preferences myprefs.json`
        - using a `.ini` file: `mozprofile --preferences myprefs.ini`
        - via the command line: `mozprofile --pref key:value --pref key:value [...]`
        
        When setting preferences from  an `.ini` file or the `--pref` switch,
        the value will be interpolated as an integer or a boolean
        (`true`/`false`) if possible.
        
        # Setting Permissions
        
        mozprofile also takes care of adding permissions to the profile.
        See https://github.com/mozilla/mozbase/blob/master/mozprofile/mozprofile/permissions.py
        
        
        # Resources
        
        Other Mozilla programs offer additional and overlapping functionality
        for profiles.  There is also substantive documentation on profiles and
        their management.
        
        - [ProfileManager](https://developer.mozilla.org/en/Profile_Manager) : 
          XULRunner application for managing profiles. Has a GUI and CLI.
        - [python-profilemanager](http://k0s.org/mozilla/hg/profilemanager/) : python CLI interface similar to ProfileManager
        - profile documentation : http://support.mozilla.com/en-US/kb/Profiles
        
Platform: UNKNOWN
