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
51 lines
825 B
ReStructuredText
51 lines
825 B
ReStructuredText
:title: Installing
|
|
|
|
Installing
|
|
==========
|
|
|
|
The module is known to pip and Debian-based distributions as
|
|
``gerritlib``.
|
|
|
|
``pip``::
|
|
|
|
pip install gerritlib
|
|
|
|
``easy_install``::
|
|
|
|
easy_install gerritlib
|
|
|
|
The module has been packaged since Ubuntu Oneiric (11.10)::
|
|
|
|
apt-get install gerritlib
|
|
|
|
And on Fedora 19 and later::
|
|
|
|
yum install gerritlib
|
|
|
|
For development::
|
|
|
|
python setup.py develop
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Documentation is included in the ``doc`` folder. To generate docs
|
|
locally execute the command::
|
|
|
|
tox -e docs
|
|
|
|
The generated documentation is then available under
|
|
``doc/build/html/index.html``.
|
|
|
|
Unit Tests
|
|
----------
|
|
|
|
Unit tests are in the ``tests`` folder.
|
|
To run the unit tests, execute the command::
|
|
|
|
tox -e py27
|
|
|
|
* Note: View ``tox.ini`` to run tests on other versions of Python.
|
|
|