blob: 767cd1d3841d8921973e711aa5809f36e3789d1f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
Pygerrit - Client library for interacting with Gerrit Code Review
=================================================================
.. image:: https://badge.fury.io/py/pygerrit.png
:target: http://badge.fury.io/py/pygerrit
.. image:: https://pypip.in/d/pygerrit/badge.png
:target: https://crate.io/packages/pygerrit/
`Gerrit Code Review`_ offers a feature-rich REST API. Pygerrit provides a
simple interface for clients to interact with Gerrit via the REST API.
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
-------------
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
-------------
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::
machine review login MyUsername password MyPassword
For instructions on how to obtain the HTTP password, refer to Gerrit's
`HTTP upload settings`_ documentation.
Usage
-----
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
>>> auth = HTTPDigestAuth('username', 'password')
>>> rest = GerritRestAPI(url='http://review.example.net', auth=auth)
>>> changes = rest.get("/changes/?q=owner:self%20status:open")
Refer to the `example`_ script for a more detailed example of how the
REST API interface works.
Copyright and License
---------------------
Copyright 2011 Sony Ericsson Mobile Communications. All rights reserved.
Copyright 2012 Sony Mobile Communications. All rights reserved.
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
|
