3ce7471b0a
* Reference the readme.rst in index.rst to remove redundancy * General cleanup and updates Change-Id: I33c9c12b94282ce3a0b3366715a3797e6c3b019c
1.1 KiB
1.1 KiB
- title
-
Installing
Installing
The module is known to pip and Debian-based distributions as
python-jenkins.
pip:
pip install python-jenkinseasy_install:
easy_install python-jenkinsThe module has been packaged since Ubuntu Oneiric (11.10):
apt-get install python-jenkinsAnd on Fedora 19 and later:
yum install python-jenkinsFor development:
python setup.py developDocumentation
Documentation is included in the doc folder. To generate
docs locally execute the command:
tox -e docsThe generated documentation is then available under
doc/build/html/index.html.
Unit Tests
Unit tests have been included and are in the tests
folder. We recently started including unit tests as examples in our
documentation so to keep the examples up to date it is very important
that we include unit tests for every module. To run the unit tests,
execute the command:
tox -e py27- Note: View
tox.inito run tests on other versions of Python.
Test Coverage
To measure test coverage, execute the command:
tox -e cover