api4jenkins 1.15.0

Jenkins Python Client

Jenkins Python Client

Python3 client library for Jenkins API.

Features

• Object oriented, each Jenkins item has corresponding class, easy to use and extend
• Base on api/json, easy to query/filter attribute of item
• Setup relationship between class just like Jenkins item
• Support api for almost every Jenkins item
• Pythonic
• Test with latest Jenkins LTS

Installation

python3 -m pip install api4jenkins

Quick start

>>> from api4jenkins import Jenkins
>>> client = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> client.version
'2.176.2'
>>> xml = """<?xml version='1.1' encoding='UTF-8'?>
... <project>
...   <builders>
...     <hudson.tasks.Shell>
...       <command>echo $JENKINS_VERSION</command>
...     </hudson.tasks.Shell>
...   </builders>
... </project>"""
>>> client.create_job('path/to/job', xml)
>>> import time
>>> item = client.build_job('path/to/job')
>>> while not item.get_build():
...      time.sleep(1)
>>> build = item.get_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/jenkins2989549474028065940.sh
+ echo $JENKINS_VERSION
2.176.2
Finished: SUCCESS
>>> build.building
False
>>> build.result
'SUCCESS'

Documentation

User Guide and API Reference is available on Read the Docs