Upload library code to public github

.gitignore

@@ -0,0 +1,2 @@
+.idea/
+env/

MANIFEST.in

@@ -0,0 +1,3 @@
+include README.txt
+recursive-include webium *.py
+include webium/jquery/jquery-1.10.2.js

README.md

@@ -1,2 +1,53 @@
-# webium
-Webium is a Page Object pattern implementation library for Python (http://martinfowler.com/bliki/PageObject.html). It allows you to extend WebElement class to your custom controls like Link, Button and group them as pages.
+# Webium
+
+Webium is a Page Object pattern implementation library for Python (http://martinfowler.com/bliki/PageObject.html).
+
+It allows you to extend WebElement class to your custom controls like Link, Button and group them as pages.
+
+Main classes are:
+
+- webium.Find
+- webium.Finds
+- webium.BasePage
+
+Basic usage example:
+
+```python
+
+from selenium.webdriver.common.by import By
+from selenium.webdriver.remote.webelement import WebElement
+from webium.controls.link import Link
+from webium.driver import get_driver
+from webium import BasePage, Find, Finds
+
+
+class GooglePage(BasePage):
+    input = Find(by=By.NAME, value='q')
+    button = Find(by=By.NAME, value='btnK')
+
+    def __init__(self):
+        super(GooglePage, self).__init__(url='http://www.google.com')
+
+
+class ResultItem(WebElement):
+    link = Find(Link, By.XPATH, './/h3/a')
+
+
+class ResultsPage(BasePage):
+    stat = Find(by=By.ID, value='resultStats')
+    results = Finds(ResultItem, By.XPATH, '//div/li')
+
+
+if __name__ == '__main__':
+    home_page = GooglePage()
+    home_page.open()
+    home_page.input.send_keys('Page Object')
+    home_page.button.click()
+    results_page = ResultsPage()
+    print 'Results summary: %s' % results_page.stat.text
+    for item in results_page.results:
+        print item.link.text
+    get_driver().quit()
+```
+
+More usage details are available here: http://wgnet.github.io/webium/.

docs/base_page.rst

@@ -0,0 +1,25 @@
+BasePage
+========
+Page is the main concept of Page Object pattern.
+In order to create your pages you should inherit ``webium.base_page.BasePage``.
+
+.. literalinclude:: ../examples/2_base_page.py
+
+url
+---
+
+If your page has static url you can specify it in ``__init__``.
+After that you can use ``open()`` method to open your page.
+
+.. literalinclude:: ../examples/3_base_page_with_url.py
+
+driver
+------
+
+Pages should have some ``WebDriver`` instance in order to manipulate browser.
+By default Webium will create the instance of ``WebDriver`` class specified in ```webium.settings.driver_class``.
+If you want to get the instance of the the driver you can call ``webium.driver.get_driver()`` method.
+
+``driver`` parameter in ``BasePage`` gives you an ability to handle WebDriver instance by yourself.
+
+.. literalinclude:: ../examples/4_base_page_driver_handling.py

docs/conf.py

@@ -0,0 +1,265 @@
+# -*- coding: utf-8 -*-
+#
+# Webium documentation build configuration file, created by
+# sphinx-quickstart on Mon Jan 12 12:24:11 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Webium'
+copyright = u'2015, Wargaming.NET'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+if not on_rtd:
+    try:
+        import sphinx_rtd_theme
+        html_theme = 'sphinx_rtd_theme'
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    except ImportError:
+        pass
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Webiumdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+}
+# The paper size ('letterpaper' or 'a4paper').
+# 'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+# 'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+# 'preamble': '',
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'webium', u'Webium Documentation',
+     [u'Wargaming.NET'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [('index', 'Webium',
+                      u'Webium Documentation',
+                      u'Wargaming.NET',
+                      'Webium',
+                      'One line description of project.',
+                      'Miscellaneous'), ]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False

docs/containers.rst

@@ -0,0 +1,16 @@
+Containers
+==========
+
+When you are specifying your classes you can perform search within them.
+Using this feature you can narrow search and handle dynamic pages without complex XPath.
+
+In order to use within your custom objects just declare ``Find`` or ``Finds``
+within your classes the same way as they are declared within page objects.
+
+Consider the page with the following DOM structure:
+
+.. image:: ./_static/containers.png
+
+In order to perform search within each item in the list we can do the following:
+
+.. literalinclude:: ../examples/10_containers.py