Skip to main content

Client library for interacting with Gerrit's REST API

Project description

https://img.shields.io/pypi/v/pygerrit2.png https://img.shields.io/pypi/l/pygerrit2.png

Pygerrit2 provides a simple interface for clients to interact with Gerrit Code Review via the REST API.

Prerequisites

Pygerrit2 is compatible with Python 2.6 and Python 2.7. Support for Python 3 is experimental.

Pygerrit2 depends on the requests library.

Installation

To install pygerrit2, simply:

$ pip install pygerrit2

Usage

This simple example shows how to get the user’s open changes. Authentication to Gerrit is done via HTTP Basic authentication, using an explicitly given username and password:

>>> from requests.auth import HTTPBasicAuth
>>> from pygerrit2.rest import GerritRestAPI
>>> auth = HTTPBasicAuth('username', 'password')
>>> rest = GerritRestAPI(url='http://review.example.net', auth=auth)
>>> changes = rest.get("/changes/?q=owner:self%20status:open")

Note that is is not necessary to add the /a/ prefix on the endpoint URLs. This is automatically added when the API is instantiated with an authentication object.

If the user’s HTTP username and password are defined in the .netrc file:

machine review.example.net login MyUsername password MyPassword

then it is possible to authenticate with those credentials:

>>> from pygerrit2.rest import GerritRestAPI
>>> from pygerrit2.rest.auth import HTTPBasicAuthFromNetrc
>>> url = 'http://review.example.net'
>>> auth = HTTPBasicAuthFromNetrc(url=url)
>>> rest = GerritRestAPI(url=url, auth=auth)
>>> changes = rest.get("/changes/?q=owner:self%20status:open")

Note that the HTTP password is not the same as the SSH password. For instructions on how to obtain the HTTP password, refer to Gerrit’s HTTP upload settings documentation.

Also note that in Gerrit version 2.14, support for HTTP Digest authentication was removed and only HTTP Basic authentication is supported. When using pygerrit2 against an earlier Gerrit version, it may be necessary to replace the HTTPBasic… classes with the corresponding HTTPDigest… versions.

Refer to the example script for a full working example.

Project details


Release history Release notifications

This version
History Node

2.0.4

History Node

2.0.3

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pygerrit2-2.0.4.tar.gz (19.8 kB) Copy SHA256 hash SHA256 Source None Dec 16, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page