Python bindings for the remote Jenkins API
Project description
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:
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
[1] | 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. |
[2] | The Next Build Number Plugin provides support for setting the next build number. |
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size python_jenkins-1.7.0-py3-none-any.whl (27.5 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size python-jenkins-1.7.0.tar.gz (61.2 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for python_jenkins-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c49c6e8770966906c0be1fe21d5e2ba08e08c93f315632929b20b3c2f2c3004c |
|
MD5 | 3a6469083c6d385b1314913357f7e41d |
|
BLAKE2-256 | eecdbdbf297d91bc383ce91ce9f955cf1b09e124b0459603efcb0bad5f0e8d7f |