Jenkins REST API client
Project description
Api4jenkins
Api4jenkins is a Jenkins REST API client for Python to access Jenkins Remote access API programmatically. It provides full functionalities to control Job, Build, Credential, View, Queue, Plugins, Node, and System operation.
Installation
python -m pip install api4jenkins
Quick start
>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> j.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>"""
>>> j.create_job('freestylejob', xml)
>>> import time
>>> item = j.build_job('freestylejob')
>>> 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
API Reference and User Guide is available on Read the Docs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
api4jenkins-1.3.tar.gz
(14.1 kB
view hashes)
Built Distribution
api4jenkins-1.3-py3-none-any.whl
(22.4 kB
view hashes)
Close
Hashes for api4jenkins-1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60f4c0859e9611bfc48769bbd8939e846220507354721e848b4ced9afbf793af |
|
MD5 | 8a746e1d2343afff662e41463de80c4a |
|
BLAKE2b-256 | d1773d7e3d9eb1dad980956e86cf3466feff1c2c93ccc1f8cca3e87d235892aa |