jjb/python-jenkins
Code Issues Proposed changes
Python API for managing jobs and nodes in a Jenkins CI instance
196 Commits 2 Branches 38 Tags 3.6 MiB
Python 100%
be3ad3dd84
Go to file
Ken Dreyer be3ad3dd84 get_build_console_output: fix docs for "number" parameter 
Looks like a bad copy-and-paste from the line above, introduced in
58185eced7

Change-Id: Ib994e83f359b46a8a0444f90c6fc0ac4f400974e
2017-10-13 13:58:34 -06:00
doc doc: add get_job_config() example 2017-05-03 10:55:40 -06:00
jenkins get_build_console_output: fix docs for "number" parameter 2017-10-13 13:58:34 -06:00
tests create_node: avoid double-encoding 2017-05-01 10:30:35 -06:00
.coveragerc Use standard cover setup 2016-12-20 22:17:24 +01:00
.gitignore Use standard cover setup 2016-12-20 22:17:24 +01: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
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-21 10:38:27 +02: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 Change repositories from stackforge to openstack 2015-11-03 06:39:27 +05:30
requirements.txt remove cap on pbr 2017-03-01 14:55:02 -08:00
setup.cfg Add py35 to tox envlist 2017-03-10 17:52:14 +08:00
setup.py Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
test-requirements.txt Remove discover from test-requirements 2016-07-22 04:02:12 +00:00
tox.ini Add py35 to tox envlist 2017-03-10 17:52:14 +08: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.↩︎