1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
|
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 nox_ 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
.. _Gerrit: https://www.gerritcodereview.com/
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
.. _nox: https://nox.thea.codes/en/stable/
.. _pip: https://pypi.python.org/pypi/pip
.. _pep8: https://pypi.python.org/pypi/pep8
|