Library for Gerrit

Go to file

Clark Boylan cdf19298e3 Fix CI setup We need to assign nodesets that can run the requested python versions when running tox-pyXY jobs. Also remove the Sphinx version cap as old sphinx cannot install with modern setuptools. We don't run CI that includes sphinx so this should be fine. If this breaks docs builds we can sort that out later. Change-Id: I577d67912fe6feb68ae50ff34c2622f9461dd122		2021-10-11 09:20:19 -07:00
doc	Add support for TCP keep alive in gerritlib	2020-09-09 17:45:39 -07:00
gerritlib	Merge "Update documentation"	2021-05-07 01:40:09 +00:00
playbooks/jeepyb-integration	Run gerritlib-jeepyb-integration on ubuntu-focal	2021-03-24 01:08:49 +00:00
tools	docker-compose: update header syntax	2020-12-08 12:51:51 +11:00
.gitignore	Update documentation	2021-01-04 22:19:38 -05:00
.gitreview	OpenDev Migration Patch	2019-04-19 19:26:01 +00:00
.stestr.conf	Replace testrepository with stestr	2020-05-20 20:07:15 +01:00
.testr.conf	Specify testenv command for tox>=2.5	2016-12-01 20:20:59 +00:00
.zuul.yaml	Fix CI setup	2021-10-11 09:20:19 -07:00
CONTRIBUTING.rst	Update documentation	2021-01-04 22:19:38 -05:00
LICENSE	Apply cookiecutter defaults	2014-06-02 18:22:04 +02:00
MANIFEST.in	Add integration testing with jeepyb and gerrit	2020-01-28 11:01:01 -08:00
README.rst	Update documentation	2021-01-04 22:19:38 -05:00
requirements.txt	Use newer paramiko	2020-01-27 16:13:11 -08:00
setup.cfg	Fix package metadata	2020-09-28 16:33:54 +00:00
setup.py	Remove erroneous comment	2013-10-27 18:36:33 -04:00
test-requirements.txt	Fix CI setup	2021-10-11 09:20:19 -07:00
tox.ini	Decouple linters from unit testing	2020-09-28 16:45:59 +01:00

README.rst

README

Gerritlib is a Python library for interacting with Gerrit. It aims to provide a more conventionally pythonic way of managing a Gerrit instance.

To install:

$ sudo python setup.py install

Online documentation:

http://gerritlib.readthedocs.org/en/latest/

Developers

Bug report:

https://storyboard.openstack.org/#!/project/718

Repository:

https://opendev.org/opendev/gerritlib

Cloning:

git clone https://opendev.org/opendev/gerritlib

Patches are submitted via Gerrit at:

https://review.opendev.org/

Please do not submit GitHub pull requests, they will be automatically closed.

More details on how you can contribute is available at:

https://docs.opendev.org/opendev/infra-manual/latest/developers.html

Writing a patch

We ask that all code submissions be pep8 and pyflakes clean. The easiest way to do that is to run tox before submitting code for review in Gerrit. It will run pep8 and pyflakes in the same manner as the automated test suite that will run on proposed patchsets.

Installing without setup.py

Then install the required python packages using pip:

$ sudo pip install gerritlib