python-jenkins 1.8.1

Python bindings for the remote Jenkins API

Python Jenkins is a python wrapper for the Jenkins REST API which aims to provide a more conventionally pythonic way of controlling a Jenkins server. It provides a higher-level API containing a number of convenience functions.

We like to use python-jenkins to automate our Jenkins servers. Here are some of the things you can use it for:

• Create new jobs

• Copy existing jobs

• Delete jobs

• Update jobs

• Get a job’s build information

• Get Jenkins master version information

• Get Jenkins plugin information

• Start a build on a job

• Create nodes

• Enable/Disable nodes

• Get information on nodes

• Create/delete/reconfig views

• Put server in shutdown mode (quiet down)

• List running builds

• Delete builds

• Wipeout job workspace

• Create/delete/update folders [1]

• Set the next build number [2]

• Install plugins

• and many more..

To install:

$ sudo python setup.py install

Online documentation:

• http://python-jenkins.readthedocs.org/en/latest/

Developers

Bug report:

• https://bugs.launchpad.net/python-jenkins

Repository:

• https://opendev.org/jjb/python-jenkins

Cloning:

• git clone https://opendev.org/jjb/python-jenkins

Patches are submitted via Gerrit at:

• https://review.opendev.org/#/q/project:jjb/python-jenkins

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

The python-jenkins developers communicate in the #openstack-jjb channel on Freenode’s IRC network.

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

• https://docs.opendev.org/opendev/infra-manual/latest/developers.html

Writing a patch

Be sure that you lint code before created an code review. The easiest way to do this is to install git pre-commit hooks.

Installing without setup.py

Then install the required python packages using pip:

$ sudo pip install python-jenkins

Footnotes

[1]

The free Cloudbees Folders Plugin provides support for a subset of the full folders functionality. For the complete capabilities you will need the paid for version of the plugin.

[2]

The Next Build Number Plugin provides support for setting the next build number.