Skip to content
This repository has been archived by the owner on Sep 16, 2021. It is now read-only.

Commit

Permalink
Removed changes from user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jrbenny35 committed Feb 15, 2017
1 parent 5375b19 commit da51822
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
User Guide
==========

FoxPuppet is a library for automating user interactions in Firefox using Selenium.
This section give some example use cases of FoxPuppet.

Example
-------

This is an example for setting up FoxPuppet and opening a private window::

from foxpuppet import FoxPuppet
from selenium.webdriver import Firefox


selenium = Firefox()
foxpuppet = FoxPuppet(selenium)

window = foxpuppet.browser.open_window(private=True)
selenium.quit()

This example opens first a non-private browser window, then proceeds to open a private browser window.
Finally it quits via :py:func:`selenium.quit`.

:Note: The initial browser window is automatically assigned to the :py:attr:`browser` attribute and is always available.

0 comments on commit da51822

Please sign in to comment.