Python API for managing jobs and nodes in a Jenkins CI instance
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andreas Jaeger 1b08573a94 Use standard cover setup 6 years ago
doc Remove redundant 'the' 6 years ago
jenkins url-proof scripts passed to run_script 6 years ago
tests url-proof scripts passed to run_script 6 years ago
.coveragerc Use standard cover setup 6 years ago
.gitignore Use standard cover setup 6 years ago
.gitreview Update .gitreview for new namespace 7 years ago
.testr.conf Use pbr, pep8 checks & fixes, add "doc" tox target 8 years ago
COPYING Added tags 11 years ago
MANIFEST.in Add MANIFEST.in 8 years ago
README.rst Change repositories from stackforge to openstack 7 years ago
bindep.txt Move other-requirements.txt to bindep.txt 6 years ago
requirements.txt Provider helper classes for plugin data management 7 years ago
setup.cfg Change repositories from stackforge to openstack 7 years ago
setup.py Use pbr, pep8 checks & fixes, add "doc" tox target 8 years ago
test-requirements.txt Remove discover from test-requirements 6 years ago
tox.ini Use standard cover setup 6 years 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
  • Create/delete/update folders1
  • Set the next build number2
  • 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.

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

Writing a patch

We ask that all code submissions be flake8 clean. The easiest way to do that is to run tox before submitting code for review in Gerrit. It will run flake8 in the same manner as the automated test suite that will run on proposed patchsets.

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.