Python API for managing jobs and nodes in a Jenkins CI instance
Go to file
Guillaume DeMengin 70dc3e4f71 Fix CI tests
Adjust some of the dependencies.

multi_key_dict is not shipped by OpenStack Zuul templates
`build-openstack-docs-pti` or `openstack-cover-jobs` we thus need to
depend on `requirements.txt`.

setuptools v66.0.0 removed support for PEP 440 non-conforming versions.
It provides pkg_resources which we use in PluginVersion.

Tox `whitelist_externals` has been renamed `allowlist_externals`.

Signed-off-by: Antoine Musso <>
Change-Id: Ie791c2bb0e7b3784913f45768d2f3db4c66ccae5
2023-03-16 21:06:36 +01:00
doc Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
jenkins Handle new master naming in Jenkins post v2.307. 2021-12-28 17:28:15 +11:00
tests Use fullname in get_job_info_regex 2021-12-14 23:39:03 +00:00
.coveragerc Use standard cover setup 2016-12-20 22:17:24 +01:00
.gitignore Replace testr with stestr 2018-04-04 23:25:21 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:46 +00:00
.pre-commit-config.yaml Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
.stestr.conf Replace testr with stestr 2018-04-04 23:25:21 +01:00
.zuul.yaml Blacklist stestr 3.0.0 and drop pypy 2020-04-17 14:46:18 +02:00
COPYING Added tags 2011-06-30 17:54:54 +01:00 Add 2014-08-22 11:29:08 -05:00
README.rst Switch links for contributors to or launchpad 2020-08-01 09:27:53 +02:00
bindep.txt Fix CI tests 2023-03-16 21:06:36 +01:00
requirements.txt Fix CI tests 2023-03-16 21:06:36 +01:00
setup.cfg Switch links for contributors to or launchpad 2020-08-01 09:27:53 +02:00 Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
test-requirements.txt Fix CI tests 2023-03-16 21:06:36 +01:00
tox.ini Fix CI tests 2023-03-16 21:06:36 +01:00



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 folders1
  • Set the next build number2
  • Install plugins
  • and many more..

To install:

$ sudo python install

Online documentation:


Bug report:



Patches are submitted via Gerrit at:

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:

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

Then install the required python packages using pip:

$ sudo pip install python-jenkins


  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.↩︎