Python API for managing jobs and nodes in a Jenkins CI instance

JP Sullivan 570a143c74 Allow build number to be a string When retreiving data from builds, the build number can have a string portion. This is for matrix jobs that define a label to retrieve one sub-build of the matrix job. The URL structure is: https://<jenkins_server>/job/>job_name>/<number>/label=<configuration>/ Allowing a string for build number allows for it to be specifed as, e.g.: 1/label=amd64 And whilst being somewhat a workaround, works without introducing complexity and modifying function calls for extra parameters. Change-Id: Ic409df6e20e85d6a417c6490472b3729f1f20cd2		1 month ago
doc	Adopt use of pre-commit hooks	2 years ago
jenkins	Allow build number to be a string	1 month ago
tests	Allow build number to be a string	1 month ago
.coveragerc	Use standard cover setup	4 years ago
.gitignore	Replace testr with stestr	2 years ago
.gitreview	OpenDev Migration Patch	1 year ago
.pre-commit-config.yaml	Adopt use of pre-commit hooks	2 years ago
.stestr.conf	Replace testr with stestr	2 years ago
.zuul.yaml	Blacklist stestr 3.0.0 and drop pypy	9 months ago
COPYING	Added tags	9 years ago
MANIFEST.in	Add MANIFEST.in	6 years ago
README.rst	Switch links for contributors to opendev.org or launchpad	5 months ago
bindep.txt	Added pypy-dev to bindep.txt	2 years ago
requirements.txt	Migration to using requests	2 years ago
setup.cfg	Switch links for contributors to opendev.org or launchpad	5 months ago
setup.py	Use pbr, pep8 checks & fixes, add "doc" tox target	6 years ago
test-requirements.txt	Blacklist stestr 3.0.0 and drop pypy	9 months ago
tox.ini	Switch links for contributors to opendev.org or launchpad	5 months ago

README.rst

README

Python Jenkins is a python wrapper for the Jenkins REST API which aims to provide a more conventionally pythonic way of controlling a Jenkins server. It provides a higher-level API containing a number of convenience functions.

We like to use python-jenkins to automate our Jenkins servers. Here are some of the things you can use it for:

Create new jobs
Copy existing jobs
Delete jobs
Update jobs
Get a job's build information
Get Jenkins master version information
Get Jenkins plugin information
Start a build on a job
Create nodes
Enable/Disable nodes
Get information on nodes
Create/delete/reconfig views
Put server in shutdown mode (quiet down)
List running builds
Delete builds
Wipeout job workspace
Create/delete/update folders¹
Set the next build number²
Install plugins
and many more..

To install:

$ sudo python setup.py install

Online documentation:

http://python-jenkins.readthedocs.org/en/latest/

Developers

Bug report:

https://bugs.launchpad.net/python-jenkins

Repository:

https://opendev.org/jjb/python-jenkins

Cloning:

git clone https://opendev.org/jjb/python-jenkins

Patches are submitted via Gerrit at:

https://review.opendev.org/#/q/project:jjb/python-jenkins

Please do not submit GitHub pull requests, they will be automatically closed.

The python-jenkins developers communicate in the #openstack-jjb channel on Freenode's IRC network.

More details on how you can contribute is available on our wiki at:

https://docs.opendev.org/opendev/infra-manual/latest/developers.html

Writing a patch

Be sure that you lint code before created an code review. The easiest way to do this is to install git pre-commit hooks.

Installing without setup.py

Then install the required python packages using pip:

$ sudo pip install python-jenkins

Footnotes

The free Cloudbees Folders Plugin provides support for a subset of the full folders functionality. For the complete capabilities you will need the paid for version of the plugin.↩
The Next Build Number Plugin provides support for setting the next build number.↩