anders-larsson / python-gerrit

Python Library to interface with Gerrits Rest API

python-gerrit

Python module that uses the Gerrit REST API as an interface to manage changes, users, groups, and more.

Scope

The scope of this library is to code stuff when people have a need for it. PR's and issues are welcome if they come with unittests and 10/10 pylint.

Usage

Examples

Structure

This lib will try to follow the structure the Gerrit API is structured. For example:

/changes/
  change
  change edit
  reviewer
  revision
  ids
  json entities
/groups/
  group
  group member
  group include
  ids
  json entities

API Reference

Developing

Are you interested in helping out with the development of python-gerrit?

Coding standards

We try to follow PEP8 standards to the best of our ability.

Testing

You should be standing in the root directory of the git repository. You will need to install the required python modules for testing.

pip install -r test-requirements.txt

This folder needs to be in the PYTHONPATH so that python can find the Gerrit module. Then run the tests.

PYTHONPATH=$(pwd)
python tests/tests_Gerrit.py