Topic
- Utilities
Intended Audience
- Developers
- Information Technology
- System Administrators
Environment
- Console
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
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 [1]
Set the next build number [2]
Install plugins
and many more..
To install:
$ sudo python setup.py install
Online documentation:
Developers
Bug report:
Repository:
Cloning:
git clone https://opendev.org/jjb/python-jenkins
Patches are submitted via Gerrit at:
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:
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
