Jenkins Python Client
Project description
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
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.10.tar.gz
(20.9 kB
view hashes)
Built Distribution
api4jenkins-1.10-py3-none-any.whl
(25.9 kB
view hashes)
Close
Hashes for api4jenkins-1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa9983418615e87acbe8374aa1cf2b49bf6160bcf47848cc62218ddf78f101f1 |
|
MD5 | 918b6ae624d04e59aca5b457d2d815b6 |
|
BLAKE2-256 | bbb3afe09743aad1549e6ac6f49bd4eae3346f9362c273e426dce451354206de |