Long description

r9102

MANIFEST.in

@@ -16,3 +16,4 @@ recursive-include remote/client/src/py *.py
 recursive-include remote/client/test/py *.py
 include selenium/src/py/selenium.py
 include selenium/src/py/__init__.py
+include docs/api/py/index.rst

docs/api/py/index.rst

@@ -0,0 +1,58 @@
+============
+Introduction
+============
+:Author: Miki Tebeka <miki@saucelabs.com>
+
+Selenium Python Client Driver is a Python language binding for Selenium Remote
+Control (version 1.0 and 2.0).
+
+Currently only the remote protocols for both 1.0 and 2.0 are working. As work
+progresses we'll add more "native" drivers.
+
+See here_ for more information.
+
+.. _here: http://code.google.com/p/selenium/
+
+Installing
+==========
+
+Python Client
+-------------
+::
+
+    pip install -U selenium
+
+Java Server
+-----------
+
+Download the server from http://selenium.googlecode.com/files/selenium-server-standalone-2.0a4.jar
+::
+
+    java -jar selenium-server-standalone-2.0a4.jar
+
+Example
+=======
+::
+
+    from selenium.remote import connect
+    from selenium import FIREFOX
+    from selenium.common.exceptions import NoSuchElementException
+    from time import sleep
+
+    wd = connect(FIREFOX) # Get local session of firefox
+    wd.get("http://www.yahoo.com") # Load page
+    assert wd.get_title() == "Yahoo!"
+    elem = wd.find_element_by_name("p") # Find the query box
+    elem.send_keys("selenium\n")
+    sleep(0.2) # Let the page load, will be added to the API
+    try:
+        wd.find_element_by_xpath("//a[contains(@href,'http://seleniumhq.org')]")
+    except NoSuchElementException:
+        assert 0, "can't find seleniumhq"
+    wd.close()
+
+Documentation
+=============
+Coming soon, in the meantime - `"Use the source Luke"`_
+
+.. _"Use the source Luke": http://code.google.com/p/selenium/source/browse/trunk/remote/client/src/py/webdriver.py

setup.py

@@ -17,11 +17,25 @@
 from setuptools import setup
 from setuptools.command.install import install
 
+from os.path import dirname, join
+
+def find_longdesc():
+    for path in ("docs/api/py/index.rst", "docs/index.rst"):
+        try:
+            index = join(dirname(__file__), path)
+            return open(index).read()
+        except IOError:
+            pass
+
+    print "WARNING: Can't find index.rst"
+    return ""
+
 setup(
     cmdclass={'install': install},
     name='selenium',
     version="2.0-dev",
     description='Python bindings for WebDriver',
+    long_description=find_longdesc(),
     url='http://code.google.com/p/selenium/',
     package_dir={
         'selenium':'.',
@@ -30,6 +44,7 @@
         'selenium.chrome' : 'chrome/src/py',
         'selenium.chrome_tests': 'chrome/test/py',
         'selenium.common': 'common/src/py',
+        'selenium.docs': 'docs/api/py',
         'selenium.remote': 'remote/client/src/py',
         'selenium.common_tests': 'common/test/py',
         'selenium.common_web': 'common/src/web',
@@ -40,6 +55,7 @@
     },
     packages=['selenium',
               'selenium.common',
+              'selenium.docs',
               'selenium.firefox',
               'selenium.ie',
               'selenium.chrome',