Python wrapper for the Jenkins CI REST API
Extensible, user and developer friendly Python interface to the Jenkins CI tool, wrapping the features exposed by the standard REST API using Pythonic objects and functions. Tested against the latest 2.x and 3.x versions of Python, and the latest trunk and LTS editions of Jenkins.
With an intuitive and well thought out interface, PyJen offers anyone familiar with the Python programming language an easy way to manage Jenkins dashboards from a simple command prompt. All core primitives of Jenkins, including views, jobs and builds are easily accessible and can be loaded, analyzed and even modified or created via simple Python commands.
Comments, suggestions and bugs may be reported to the project maintainer
Full API documentation can be found at TheFriendlyCoder.com.
Quick start guide
- First, we recommend that you install the pip package manager as described here
- Install PyJen directly from PyPI using PIP:
# pip install pyjen
- import the pyjen module and start scripting! See below for some common examples.
Display a list of all jobs on the default view
from pyjen import * jk = jenkins.easy_connect("http://localhost:8080") vw = jk.get_default_view() jobs = vw.get_jobs() for j in jobs: print j.get_name()
Disable all jobs in a view named “My View”
from pyjen import * jk = jenkins.easy_connect("http://localhost:8080") vw = jk.find_view("My View") vw.disable_all_jobs()
Get all upstream dependencies of a job named “JobA”
from pyjen import * j = job.easy_connect("http://localhost:8080/job/JobA") upstream = j.get_upstream_jobs(True) for u in upstream: print u.get_name()
Clone all jobs in a view who are named with a ‘trunk’ identifier for a new branch configuration
from pyjen import * v = view.easy_connect("http://localhost:8080/views/trunk_builds") v.clone_all_jobs(".*trunk.*", "branch")