Remove support for Gerrit over ssh

From now only the REST API is supported.

This makes installation of the package a bit lighter as we no
longer depend on paramiko and pycrypto

Change-Id: Ieda773d596fd43047c05895f3304690ddf709094

1 files changed, 2 insertions, 58 deletions

diff --git a/README.rst b/README.rst
index 82b38b1..4ab041c 100644
--- a/README.rst
+++ b/README.rst
@@ -8,7 +8,7 @@ Pygerrit - Client library for interacting with Gerrit Code Review
         :target: https://crate.io/packages/pygerrit/
 
 Pygerrit is a Python library to interact with the
-`Gerrit Code Review`_ system over ssh or via the REST API.
+`Gerrit Code Review`_ system's REST API.
 
 Installation
 ------------
@@ -28,16 +28,6 @@ and 2.7.x.  Support for other platforms and Python versions is not guaranteed.
 Configuration
 -------------
 
-For easier connection to the review server over ssh, the ssh connection
-parameters (hostname, port, username) can be given in the user's ``.ssh/config``
-file::
-
-    Host review
-      HostName review.example.net
-      Port 29418
-      User username
-
-
 For easier connection to the review server over the REST API, the user's
 HTTP username and password can be given in the user's ``.netrc`` file::
 
@@ -48,51 +38,6 @@ For instructions on how to obtain the HTTP password, refer to Gerrit's
 `HTTP upload settings`_ documentation.
 
 
-SSH Interface
--------------
-
-The SSH interface can be used to run commands on the Gerrit server::
-
-    >>> from pygerrit.ssh import GerritSSHClient
-    >>> client = GerritSSHClient("review")
-    >>> result = client.run_gerrit_command("version")
-    >>> result
-    <GerritSSHCommandResult [version]>
-    >>> result.stdout
-    <paramiko.ChannelFile from <paramiko.Channel 2 (closed) -> <paramiko.Transport at 0xd2387d90L (cipher aes128-cbc, 128 bits) (active; 0 open channel(s))>>>
-    >>> result.stdout.read()
-    'gerrit version 2.6.1\n'
-    >>>
-
-Event Stream
-------------
-
-Gerrit offers a ``stream-events`` command that is run over ssh, and returns back
-a stream of events (new change uploaded, change merged, comment added, etc) as
-JSON text.
-
-This library handles the parsing of the JSON text from the event stream,
-encapsulating the data in event objects (Python classes), and allowing the
-client to fetch them from a queue. It also allows users to easily add handling
-of custom event types, for example if they are running a customised Gerrit
-installation with non-standard events::
-
-    >>> from pygerrit.client import GerritClient
-    >>> client = GerritClient("review")
-    >>> client.gerrit_version()
-    '2.6.1'
-    >>> client.start_event_stream()
-    >>> client.get_event()
-    <CommentAddedEvent>: <Change 12345, platform/packages/apps/Example, master> <Patchset 1, 5c4b2f76297f04fbab77eb8c3462e087bc4b6f90> <Account Bob Example (bob.example@example.com)>
-    >>> client.get_event()
-    <CommentAddedEvent>: <Change 67890, platform/frameworks/example, master> <Patchset 2, c7d4f9956c80b1df66a66d66dea3960e71de4910> <Account John Example (john.example@example.com)>
-    >>> client.stop_event_stream()
-    >>>
-
-
-Refer to the `example`_ script for a more detailed example of how the SSH
-event stream interface works.
-
 REST API
 --------
 
@@ -106,7 +51,7 @@ interface for clients to interact with Gerrit via the REST API::
     >>> changes = rest.get("/changes/?q=owner:self%20status:open")
 
 
-Refer to the `rest_example`_ script for a more detailed example of how the
+Refer to the `example`_ script for a more detailed example of how the
 REST API interface works.
 
 Copyright and License
@@ -121,6 +66,5 @@ license details.
 
 .. _`Gerrit Code Review`: https://code.google.com/p/gerrit/
 .. _example: https://github.com/sonyxperiadev/pygerrit/blob/master/example.py
-.. _rest_example: https://github.com/sonyxperiadev/pygerrit/blob/master/rest_example.py
 .. _`HTTP upload settings`: https://gerrit-documentation.storage.googleapis.com/Documentation/2.8/user-upload.html#http
 .. _LICENSE: https://github.com/sonyxperiadev/pygerrit/blob/master/LICENSE