Basic module structure

imurchie · imurchie · commit 189f22d3f950 · 2014-04-07T10:05:24.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+.DS_Store
+
+*~
+*#
+*._*
+*.log
+*.log.*
+
+*.pyc
+
+build
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2012-2014 Appium Committers
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+Appium Python Client
+====================
+
+An extension library for adding [Selenium 3.0 draft](https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile) functionality to [Appium](https://github.com/appium/appium).
+
+
diff --git a/appium/__init__.py b/appium/__init__.py
@@ -0,0 +1 @@
+
diff --git a/appium/mobilecommand.py b/appium/mobilecommand.py
@@ -0,0 +1,2 @@
+class MobileCommand(object):
+    CONTEXTS = 'contexts'
diff --git a/appium/webdriver/__init__.py b/appium/webdriver/__init__.py
@@ -0,0 +1 @@
+from webdriver import WebDriver as Remote
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -0,0 +1,10 @@
+#!/usr/bin/python
+
+from selenium import webdriver
+
+class WebDriver(webdriver.Remote):
+    def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
+        desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False):
+
+        # we have no new initialization to do
+        super(WebDriver, self).__init__(command_executor, desired_capabilities, browser_profile, proxy, keep_alive)
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -0,0 +1,36 @@
+Appium Python Client Plan
+=========================
+
+This library will be a simple extension of the official Python bindings, through
+subclassing, to add the new methods. I would like to maintain the same package
+structure, so that switching to the Appium library would be a matter of changing
+the import.
+
+The official client allows for three ways to interact with the server: with the
+`selenium` class, with the `webdriver.Remote` class, and with specific browser
+classes, which subclass `webdriver.Remote` in `webdriver.*` classes. It seems
+like we would not need to update the browser classes for our use case, and the
+first is for RC, which we don't support. Thus we can subclass the official
+`webdriver.Remote` classes and add the new methods. Otherwise we would need to
+use composition, since we have to change the base class and subclasses.
+
+Usage will remain as it currently is, using the first two methods from above,
+other than importing from Appium:
+
+```python
+from appium import webdriver
+
+desired_caps = {}
+# ...
+
+driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+
+print driver.get_window_size()
+elem = driver.find_element_by_name('Graphics')
+elem.click()
+driver.quit()
+```
+
+As Selenium catches up, the methods can be seemlessly removed from the Appium
+client. Any methods outside of the spec can remain and be used without issue,
+should the user choose.
diff --git a/setup.py b/setup.py
@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+from distutils.core import setup
+
+setup(name='Python-Client',
+      version='0.1',
+      description='Appium Python Client',
+      author='Isaac Murchie',
+      author_email='isaac@saucelabs.com',
+      url='http://appium.io/',
+      packages=['appium', 'appium.webdriver'],
+      license='Apache 2.0'
+     )

-Original file line number
+Diff line change
@@ @@ -0,0 +1,11 @@ @@
 +.DS_Store
++
 +*~
 +*#
 +*._*
 +*.log
 +*.log.*
++
 +*.pyc
++
 +build
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+class MobileCommand(object):`
	`2`	`+ CONTEXTS = 'contexts'`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+from webdriver import WebDriver as Remote`