58ca447785
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
63 lines
1.4 KiB
ReStructuredText
63 lines
1.4 KiB
ReStructuredText
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://git.openstack.org/cgit/openstack-infra/gerritlib
|
|
|
|
Cloning::
|
|
|
|
git clone https://git.openstack.org/openstack-infra/gerritlib
|
|
|
|
Patches are submitted via Gerrit at:
|
|
|
|
* https://review.openstack.org/
|
|
|
|
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:
|
|
|
|
* http://docs.openstack.org/infra/manual/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
|
|
|
|
.. _Gerrit: https://code.google.com/p/gerrit/
|
|
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
|
|
.. _tox: https://testrun.org/tox
|
|
.. _pip: https://pypi.python.org/pypi/pip
|
|
.. _pep8: https://pypi.python.org/pypi/pep8
|