jenkinsapi 0.3.22

A Python API for accessing resources on a Jenkins continuous-integration server.

Installation

pip install jenkinsapi

Logging

JenkinsAPI emits request/response debug logs when enabled. You can opt in with the environment variable or by calling the helper:

export JENKINSAPI_LOG_LEVEL=DEBUG

from jenkinsapi.utils.logging import configure_logging

configure_logging("INFO")

Important Links

• Documentation

• Source Code

• Support and bug-reports

• Releases

About this library

Jenkins is the market leading continuous integration system.

Jenkins (and its predecessor Hudson) are useful projects for automating common development tasks (e.g. unit-testing, production batches) - but they are somewhat Java-centric.

Jenkinsapi makes scripting Jenkins tasks a breeze by wrapping the REST api into familiar python objects.

Here is a list of some of the most commonly used functionality

• Add, remove, and query Jenkins jobs

• Control pipeline execution

  • Query the results of a completed build

  • Block until jobs are complete or run jobs asyncronously

  • Get objects representing the latest builds of a job

• Artifact management

  • Search for artifacts by simple criteria

  • Install artifacts to custom-specified directory structures

• Search for builds by source code revision

• Create, destroy, and monitor

  • Build nodes (Webstart and SSH slaves)

  • Views (including nested views using NestedViews Jenkins plugin)

  • Credentials (username/password and ssh key)

• Authentication support for username and password

• Manage jenkins and plugin installation

Full library capabilities are outlined in the Documentation

Get details of jobs running on Jenkins server

"""Get job details of each job that is running on the Jenkins instance"""
def get_job_details():
    # Refer Example #1 for definition of function 'get_server_instance'
    server = get_server_instance()
    for job_name, job_instance in server.get_jobs():
        print 'Job Name:%s' % (job_instance.name)
        print 'Job Description:%s' % (job_instance.get_description())
        print 'Is Job running:%s' % (job_instance.is_running())
        print 'Is Job enabled:%s' % (job_instance.is_enabled())

Disable/Enable a Jenkins Job

def disable_job():
    """Disable a Jenkins job"""
    # Refer Example #1 for definition of function 'get_server_instance'
    server = get_server_instance()
    job_name = 'nightly-build-job'
    if (server.has_job(job_name)):
        job_instance = server.get_job(job_name)
        job_instance.disable()
        print 'Name:%s,Is Job Enabled ?:%s' % (job_name,job_instance.is_enabled())

Use the call job_instance.enable() to enable a Jenkins Job.

Creating jobs in folders

When using the Folders plugin, you can pass folder paths directly:

jenkins.create_job("folder1/folder2/job-name", config_xml)
jenkins.create_job("/job/folder1/job/folder2/job-name", config_xml)

Known issues

• Job deletion operations fail unless Cross-Site scripting protection is disabled.

For other issues, please refer to the support URL

Development

• Make sure that you have Java installed. Jenkins will be automatically downloaded and started during tests.

• Create virtual environment for development

• Install package in development mode

uv sync

• Make your changes, write tests and check your code

uv run pytest -sv

Python versions

The project has been tested against Python versions:

• 3.9 - 3.14

Jenkins versions

Project tested on both stable (LTS) and latest Jenkins versions.

Project Contributors

• Aleksey Maksimov ([e-mail])

• Salim Fadhley ([e-mail])

• Ramon van Alteren ([e-mail])

• Ruslan Lutsenko ([e-mail])

• Cleber J Santos ([e-mail])

• William Zhang ([e-mail])

• Victor Garcia ([e-mail])

• Bradley Harris ([e-mail])

• Kyle Rockman ([e-mail])

• Sascha Peilicke ([e-mail])

• David Johansen ([e-mail])

• Misha Behersky ([e-mail])

• Clinton Steiner ([e-mail])

Please do not contact these contributors directly for support questions! Use the GitHub tracker instead.