Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Jenkins rest api client

Project description

Build Status Coverage Status


jenkinsx is a Jenkins REST api client for python, which provides pythonic way to interact with Jenkins server.It Includes but not limits functionalities for Job, Build, Node, View, Credential, BuildQueue, and System:

  • get/delete/create/move/rename/copy/build/enable/disable job or folder, iterate children jobs with depth, folder based views/credentials functionalities
  • get/iterate builds of project, stop/term/kill build, get progressive console output.
  • get/delete/create/iterate views for jenkins or folder. add/remove jobs to/from view.
  • get/delete/create/iterate credentials for system or folder.
  • get/delete/create/iterate nodes, run groovy script on node.
  • get/cancel/iterate queue item, get job/build from queue item.
  • restart/safe restart/quiet down/cancel quiet down/run groovy script for master
  • get item status(int, bool, str) by accessing attribute of python object.
  • install/uninstall/iterate plugin, check installation status, change update site and set proxy


pip install jenkinsx


>>> from jenkinsx import Jenkins
>>> j = Jenkins('', auth=('admin', 'admin'))
>>> j.version
>>> xml = """<?xml version='1.1' encoding='UTF-8'?>
... <project>
...   <builders>
...     <hudson.tasks.Shell>
...       <command>echo $JENKINS_VERSION</command>
...     </hudson.tasks.Shell>
...   </builders>
... </project>"""
>>> j.create_job('freestylejob', xml)
>>> job = j.get_job('freestylejob')
>>> print(job)
>>> print(job.parent)
>>> print(job.jenkins)
>>> import time
>>> item =
>>> while not item.get_build():
...      time.sleep(1)
>>> build = item.get_build()
>>> print(build)
>>> for line in build.progressive_output():
...     print(line)
Started by user admin
Running as SYSTEM
Building in workspace /var/jenkins_home/workspace/freestylejob
[freestylejob] $ /bin/sh -xe /tmp/
Finished: SUCCESS
>>> build.building
>>> build.result

More usage can be found in e2e test


Feel free to open pull requests to contribute your code or idea

Project details

Release history Release notifications

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jenkinsx, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size jenkinsx-1.0-py3-none-any.whl (20.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jenkinsx-1.0.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page