diff options
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 33 |
1 files changed, 21 insertions, 12 deletions
@@ -7,15 +7,11 @@ Pygerrit - Client library for interacting with Gerrit Code Review .. image:: https://pypip.in/d/pygerrit/badge.png :target: https://crate.io/packages/pygerrit/ -Pygerrit is a Python library to interact with the -`Gerrit Code Review`_ system's REST API. +`Gerrit Code Review`_ offers a feature-rich REST API. Pygerrit provides a +simple interface for clients to interact with Gerrit via the REST API. -Installation ------------- - -To install pygerrit, simply:: - - $ pip install pygerrit +Note that from version 0.3.0 Pygerrit no longer includes support for the Gerrit +ssh interface. For ssh support please use version 0.2.5 or earlier. Prerequisites @@ -24,6 +20,16 @@ Prerequisites Pygerrit has been tested on Ubuntu 10.4 and Mac OSX 10.8.4, with Python 2.6.x and 2.7.x. Support for other platforms and Python versions is not guaranteed. +Pygerrit depends on the `requests`_ library. + + +Installation +------------ + +To install pygerrit, simply:: + + $ pip install pygerrit + Configuration ------------- @@ -38,11 +44,12 @@ For instructions on how to obtain the HTTP password, refer to Gerrit's `HTTP upload settings`_ documentation. -REST API --------- +Usage +----- -Gerrit offers a feature-rich REST API. This library provides a simple -interface for clients to interact with Gerrit via the REST API:: +This simple example shows how to get the user's open changes, authenticating +to Gerrit via HTTP Digest authentication using an explicitly given username and +password:: >>> from requests.auth import HTTPDigestAuth >>> from pygerrit.rest import GerritRestAPI @@ -54,6 +61,7 @@ interface for clients to interact with Gerrit via the REST API:: Refer to the `example`_ script for a more detailed example of how the REST API interface works. + Copyright and License --------------------- @@ -65,6 +73,7 @@ Licensed under The MIT License. Please refer to the `LICENSE`_ file for full license details. .. _`Gerrit Code Review`: https://code.google.com/p/gerrit/ +.. _`requests`: https://github.com/kennethreitz/requests .. _example: https://github.com/sonyxperiadev/pygerrit/blob/master/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 |