jjb/python-jenkins
Code Issues Proposed changes
Python API for managing jobs and nodes in a Jenkins CI instance
157 Commits 2 Branches 38 Tags 3.6 MiB
Python 100%
3b2dc286c9
Go to file
Jeremy Stanley 3b2dc286c9 Update .gitreview for new namespace 
Change-Id: I55daf7c070f7a0a619e7a4376c6534cdf0cf483f
2015-10-17 22:37:18 +00:00
doc Merge "Provider helper classes for plugin data management" 2015-09-28 17:34:05 +00:00
jenkins Handle depth errors in get_running_builds 2015-10-07 17:01:55 -07:00
tests Handle depth errors in get_running_builds 2015-10-07 17:01:55 -07:00
.coveragerc Add support for measuring coverage 2014-05-21 08:25:09 -07:00
.gitignore Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:37:18 +00:00
.testr.conf Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
COPYING Added tags 2011-06-30 17:54:54 +01:00
MANIFEST.in Add MANIFEST.in 2014-08-22 11:29:08 -05:00
README.rst Support ability to install plugins 2015-09-28 10:21:21 -07:00
requirements.txt Provider helper classes for plugin data management 2015-09-28 18:15:57 +01:00
setup.cfg Doc Change: update supported python versions 2015-02-12 16:22:47 -08:00
setup.py Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
test-requirements.txt Provider helper classes for plugin data management 2015-09-28 18:15:57 +01:00
tox.ini Change order of tox envs for testr 2015-09-15 10:24:36 -07:00

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.↩︎