twmr / jenkinsapi

Originally based on pyjenkinsci... release tree: https://github.com/salimfadhley/jenkinsapi

jenkinsapi

Table of Contents

About this library

Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an easy to use conventional python interface.

Jenkins (and It's predecessor Hudson) are useful projects for automating common development tasks (e.g. unit-testing, production batches) - but they are somewhat Java-centric. Thankfully the designers have provided an excellent and complete REST interface. This library wraps up that interface as more conventional python objects in order to make most Jenkins oriented tasks simpler.

This library can help you:

• Query the test-results of a completed build
• Get a objects representing the latest builds of a job
• Search for artefacts by simple criteria
• Block until jobs are complete
• Install artefacts to custom-specified directory structures
• username/password auth support for jenkins instances with auth turned on
• Ability to search for builds by subversion revision
• Ability to add/remove/query jenkins slaves

Important Links

Project source code: github: https://github.com/salimfadhley/jenkinsapi

Project documentation: http://packages.python.org/jenkinsapi/

Releases: http://pypi.python.org/pypi/jenkinsapi

Installation

Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute to automatically install this project.

Most users can do the following: :

easy_install jenkinsapi

If you'd like to install in multi-version mode: :

easy_install -m jenkinsapi

Project Authors

• Salim Fadhley ([email protected])
• Ramon van Alteren ([email protected])
• Ruslan Lutsenko ([email protected])
• Cleber J Santos ([email protected])
• William Zhang ([email protected])
• Victor Garcia ([email protected])

License

The MIT License (MIT): Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.