Welcome to Gerrit Client with Python’s documentation!

python-gerrit-api provides a simple interface for clients to interact with Gerrit via the REST API.

Compatibility

  • This package is compatible Python versions 2.7, 3.5+.

Installation

Use pip to install the latest stable version of python-gerrit-api:

$ sudo pip install python-gerrit-api

The current development version is available on github. Use git and python setup.py to install it:

$ git clone https://github.com/shijl0925/python-gerrit-api.git
$ cd python-gerrit-api
$ sudo python setup.py install

Change Log

See the CHANGELOG.md file.

Documentation

This part of the documentation will show you how to get started in using python-gerrit-api.

The Client is easy to use, you just need to initialize it with the connection parameters.

Setup a Gerrit Client

from gerrit import GerritClient

client = GerritClient(base_url="https://yourgerrit", username='******', password='xxxxx')

Example

Refer to the example script for a full working example.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Indices and tables