Bug 1005758 - Clean up marionette package descriptions on pypi. r=mdas

testing/marionette/client/README.md

@@ -1,44 +0,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/. -->
-
-# Marionette Client
-
-[Marionette](https://developer.mozilla.org/en/Marionette) is a 
-Mozilla project to enable remote automation in Gecko-based projects,
-including desktop Firefox, mobile Firefox, and Boot-to-Gecko.
-
-It utilizes the [remote-debugger](https://wiki.mozilla.org/Platform/JSDebugv2) 
-inside Gecko for the transport layer of the Marionette server.  The commands
-the Marionette server will eventually implement are based on
-Selenium's [JSON Wire Protocol](http://code.google.com/p/selenium/wiki/JsonWireProtocol),
-although not all commands are presently implemented, and additional commands
-will likely be added.
-
-## Package Files
-
-- client.py:  This is the Marionette socket client; it speaks the same
-  socket protocol as the Gecko remote debugger.
-- marionette.py:  The Marionette client.  This uses client.py to communicate
-  with a server that speaks the Gecko remote debugger protocol.
-  This allows Selenium tests to utilize Marionette.
-- testserver.py:  A socket server which mimics the remote debugger in
-  Gecko, and can be used to test pieces of the Marionette client.
-- test_protocol.py:  Tests the Marionette JSON Protocol by using testserver.py.
-
-## Installation
-
-You'll need the ManifestDestiny and MozHttpd packages from Mozbase:
-
-    git clone git://github.com/mozilla/mozbase.git
-    cd mozbase
-    python setup_development.py
-
-Other than that, there are no special requirements.
-
-
-## Writing and Running Tests Using Marionette
-
-See [Writing Marionette tests](https://developer.mozilla.org/en/Marionette/Tests),
-and [Running Marionette tests](https://developer.mozilla.org/en/Marionette/Running_Tests).
-

testing/marionette/client/docs/index.rst

@@ -8,7 +8,8 @@ Marionette Python Client
 
 The Marionette python client library allows you to remotely control a
 Gecko-based browser or device which is running a Marionette_
-server.
+server. This includes desktop Firefox and FirefoxOS (support for
+Firefox for Android is planned, but not yet fully implemented).
 
 .. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette
 

testing/marionette/client/setup.py

@@ -4,13 +4,6 @@ import sys
 
 version = '0.7.7'
 
-# get documentation from the README
-try:
-    here = os.path.dirname(os.path.abspath(__file__))
-    description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
-    description = ''
-
 # dependencies
 with open('requirements.txt') as f:
     deps = f.read().splitlines()
@@ -35,7 +28,7 @@ else:
 setup(name='marionette_client',
       version=version,
       description="Marionette test automation client",
-      long_description=description,
+      long_description='See http://marionette-client.readthedocs.org/',
       classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Jonathan Griffin',

testing/marionette/transport/README.md

@@ -1,14 +0,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/. -->
-
-# Marionette Transport Layer
-
-[Marionette](https://developer.mozilla.org/en/Marionette) is a 
-Mozilla project to enable remote automation in Gecko-based projects,
-including desktop Firefox, mobile Firefox, and Firefox OS.   It's inspired
-by [Selenium Webdriver](http://www.seleniumhq.org/projects/webdriver/).
-
-This package defines the transport layer used by a Marionette client to
-communicate with the Marionette server embedded in Gecko.  It has no entry
-points; rather it's designed to be used by Marionette client implementations.

testing/marionette/transport/setup.py

@@ -1,14 +1,18 @@
-import os
 from setuptools import setup, find_packages
 
 version = '0.1'
 
-# get documentation from the README
+long_description = \
-try:
+"""Marionette_ is a Mozilla project to enable remote automation in Gecko-based
-    here = os.path.dirname(os.path.abspath(__file__))
+projects, including desktop Firefox, mobile Firefox, and Firefox OS. It is
-    description = file(os.path.join(here, 'README.md')).read()
+inspired by `Selenium Webdriver`_.
-except (OSError, IOError):
+
-    description = ''
+This package defines the transport layer used by a Marionette client to
+communicate with the Marionette server embedded in Gecko.  It has no entry
+points; rather it's designed to be used by a Marionette client implementation.
+
+.. _Marionette: https://developer.mozilla.org/en/Marionette
+.. _`Selenium Webdriver`: http://www.seleniumhq.org/projects/webdriver/"""
 
 # dependencies
 deps = []
@@ -16,7 +20,7 @@ deps = []
 setup(name='marionette-transport',
       version=version,
       description="Transport layer for Marionette client",
-      long_description=description,
+      long_description=long_description,
       classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Tools Team',