Metadata-Version: 1.0
Name: fxapom
Version: 1.0
Summary: Mozilla Firefox Accounts Page Object Model
Home-page: https://github.com/mozilla/fxapom
Author: Mozilla Web QA
Author-email: mozwebqa@mozilla.org
License: MPL 2.0
Description: Firefox Accounts Page Object Model
        ==================================
        [Selenium WebDriver][webdriver] compatible page object model and utilities for [Firefox Accounts][FxA]
        
        [FxA]: https://accounts.firefox.com
        [webdriver]: http://docs.seleniumhq.org/docs/03_webdriver.jsp
        
        Overview
        -------------
        This package contains a utility to create a test Firefox Account on either the dev or prod instance of Firefox Accounts,
        as well as a set of page objects that can be used to interact with Firefox Accounts' sign in screens.
        
        Usage
        -----
        To create a test Firefox Account, use the `create_account` method in the `FxATestAccount` object.
        You should pass the base url for the site for which you are creating the account into the constructor
        for `FxATestAccount`, or, if you know you want to create a production Account, you can omit that argument.
        
        Example:
        ```python
        from fxapom.fxapom import FxATestAccount
        acct = FxATestAccount(base_url='https://www-dev.allizom.org').create_account()
        ```
        
        To sign in via Firefox Accounts, use the `sign_in` method in the `WebDriverFxA` object,
        passing in the email addresss and password.
        
        Example:
        ```python
        from fxapom.fxapom import WebDriverFxA
        fxa = WebDriverFxA(mozwebqa)
        fxa.sign_in(email_address, password)
        ```
        
        Note that we are passing `mozwebqa` into the constructor of `WebDriverFxA`, which is only
        generally available when using our in-house plugin [pytest-mozwebqa][plugin].
        
        [plugin]: https://github.com/mozilla/pytest-mozwebqa
        
        To create an account and then use it to sign in, use both tools described above.
        
        Example:
        ```python
        from fxapom.fxapom import FxATestAccount
        from fxapom.fxapom import WebDriverFxA
        acct = FxATestAccount(base_url='https://www-dev.allizom.org').create_account()
        fxa = WebDriverFxA(mozwebqa)
        fxa.sign_in(acct.email, acct.password)
        ```
        
        Running The Tests
        -----------------
        * Install the requirements using `pip install -r requirements.txt`
        * Run the tests using a local Firefox browser via `py.test --driver=Firefox tests`
        
        License
        -------
        This software is licensed under the [MPL](http://www.mozilla.org/MPL/2.0/) 2.0:
        
            This Source Code Form is subject to the terms of the Mozilla Public
            License, v. 2.0. If a copy of the MPL was not distributed with this
            file, You can obtain one at http://mozilla.org/MPL/2.0/.
        
Keywords: mozilla
Platform: UNKNOWN
