Library for Gerrit
Go to file
Khai Do 58ca447785 Update project docs
This change does the following:
  Update docs with more info
  Add an example usage of this library
  Add pbr versioning to docs
  Updates the requirements
  Rarrange the docs to look better on pypi

Lots of the elements to do above were borrowed from
python-jenkins and jenkins-job-builder projects.

Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-04-20 13:10:34 -07:00
doc Update project docs 2015-04-20 13:10:34 -07:00
gerritlib Update project docs 2015-04-20 13:10:34 -07:00
tests Update project docs 2015-04-20 13:10:34 -07:00
.gitignore Doc generation support 2015-02-11 10:09:59 +01:00
.gitreview Updated .gitreview location 2012-12-16 10:40:40 -08:00
.testr.conf Update project docs 2015-04-20 13:10:34 -07:00
CONTRIBUTING.rst Update project docs 2015-04-20 13:10:34 -07:00
LICENSE Apply cookiecutter defaults 2014-06-02 18:22:04 +02:00
MANIFEST.in Add setup.py to project. 2012-07-11 13:00:12 -07:00
README.rst Update project docs 2015-04-20 13:10:34 -07:00
requirements.txt Update project docs 2015-04-20 13:10:34 -07:00
setup.cfg Update project docs 2015-04-20 13:10:34 -07:00
setup.py Remove erroneous comment 2013-10-27 18:36:33 -04:00
test-requirements.txt Update project docs 2015-04-20 13:10:34 -07:00
tox.ini Update project docs 2015-04-20 13:10:34 -07: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:

Developers

Bug report:

Repository:

Cloning:

git clone https://git.openstack.org/openstack-infra/gerritlib

Patches are submitted via Gerrit at:

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

More details on how you can contribute is available on our wiki at:

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