jenkinsapi

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

These details have not been verified by PyPI

Project description

https://codecov.io/gh/pycontribs/jenkinsapi/branch/master/graph/badge.svg

Installation

pip install jenkinsapi

Important Links

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.

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.13

Jenkins versions

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

Project Contributors

Aleksey Maksimov (ctpeko3a@gmail.com)
Salim Fadhley (sal@stodge.org)
Ramon van Alteren (ramon@vanalteren.nl)
Ruslan Lutsenko (ruslan.lutcenko@gmail.com)
Cleber J Santos (cleber@simplesconsultoria.com.br)
William Zhang (jollychang@douban.com)
Victor Garcia (bravejolie@gmail.com)
Bradley Harris (bradley@ninelb.com)
Kyle Rockman (kyle.rockman@mac.com)
Sascha Peilicke (saschpe@gmx.de)
David Johansen (david@makewhat.is)
Misha Behersky (bmwant@gmail.com)
Clinton Steiner (clintonsteiner@gmail.com)

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

Project details

These details have not been verified by PyPI

Release history Release notifications | RSS feed

This version

0.3.17

Nov 1, 2025

0.3.16

Sep 9, 2025

0.3.15

Aug 20, 2025

0.3.15.dev8 pre-release

Sep 9, 2025

0.3.15.dev2 pre-release

Aug 20, 2025

0.3.14

Mar 18, 2025

0.3.14.dev5 pre-release

Mar 18, 2025

0.3.14.dev2 pre-release

Mar 18, 2025

0.3.13

Jan 26, 2023

0.3.11

Oct 31, 2019

0.3.10

Oct 18, 2019

0.3.9

Apr 13, 2019

0.3.8

Dec 27, 2018

0.3.7

Nov 28, 2018

0.3.6

Dec 14, 2017

0.3.4

Apr 8, 2017

0.3.3

Oct 19, 2016

0.3.2

Aug 25, 2016

0.3.1

Aug 21, 2016

0.3.0

Aug 1, 2016

0.2.32

Jul 8, 2016

0.2.31

Sep 21, 2016

0.2.30

May 12, 2016

0.2.29

Nov 5, 2015

0.2.28

May 1, 2015

0.2.27

Apr 23, 2015

0.2.26

Jan 13, 2015

0.2.25

Jul 30, 2014

0.2.24

Jul 30, 2014

0.2.23

Jul 28, 2014

0.2.22

Jul 27, 2014

0.2.21

Jul 27, 2014

0.2.20

Jul 10, 2014

0.2.19

Apr 12, 2014

0.2.18

Feb 5, 2014

0.2.17

Jan 29, 2014

0.2.16

Oct 17, 2013

0.2.15

Oct 12, 2013

0.2.14

Sep 21, 2013

0.2.13

Aug 22, 2013

0.2.12

Jul 18, 2013

0.2.11

Jul 9, 2013

0.2.10

Jul 5, 2013

0.2.9

Jun 30, 2013

0.2.8

Jun 26, 2013

0.2.7

Jun 24, 2013

0.2.6

Jun 23, 2013

0.2.5

Jun 23, 2013

0.2.3

Jun 20, 2013

0.2.2

Jun 18, 2013

0.2.1

Jun 18, 2013

0.2.0

Jun 15, 2013

0.1.16

Jun 1, 2013

0.1.15

May 31, 2013

0.1.13

May 4, 2013

0.1.12

Jan 27, 2013

0.1.11

Jul 4, 2012

0.1.10

Jul 4, 2012

0.1.9

Jun 4, 2012

0.1.8

May 31, 2012

0.1.7

May 30, 2012

0.1.6

Mar 8, 2012

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jenkinsapi-0.3.17.tar.gz (403.0 kB view details)

Uploaded Nov 1, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

jenkinsapi-0.3.17-py3-none-any.whl (71.0 kB view details)

Uploaded Nov 1, 2025 Python 3

File details

Details for the file jenkinsapi-0.3.17.tar.gz.

File metadata

Download URL: jenkinsapi-0.3.17.tar.gz
Upload date: Nov 1, 2025
Size: 403.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jenkinsapi-0.3.17.tar.gz
Algorithm	Hash digest
SHA256	`63333ecb6b1684433e34ade0d205c87dfcc378163cfd02428078620973315790`
MD5	`c3dee5273044462fc0120e3aef17579f`
BLAKE2b-256	`57924bf312ee8b6cc4db4b256ab61d9694b9641c068c88237a2286e681b1447a`

See more details on using hashes here.

Provenance

The following attestation bundles were made for jenkinsapi-0.3.17.tar.gz:

Publisher: release.yml on pycontribs/jenkinsapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: jenkinsapi-0.3.17.tar.gz
- Subject digest: 63333ecb6b1684433e34ade0d205c87dfcc378163cfd02428078620973315790
- Sigstore transparency entry: 660064334
- Sigstore integration time: Nov 1, 2025
Source repository:
- Permalink: pycontribs/jenkinsapi@14d9d421401f0c1e912818205ae18a37e53ea288
- Branch / Tag: refs/tags/0.3.17
- Owner: https://github.com/pycontribs
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@14d9d421401f0c1e912818205ae18a37e53ea288
- Trigger Event: release

File details

Details for the file jenkinsapi-0.3.17-py3-none-any.whl.

File metadata

Download URL: jenkinsapi-0.3.17-py3-none-any.whl
Upload date: Nov 1, 2025
Size: 71.0 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jenkinsapi-0.3.17-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3f12733b60e86e6f06c06756e9d10eb3cc5bd7fb3eeb0e04104200d3a68d8eac`
MD5	`ca61d17363b3c728d73443dcd2ec0370`
BLAKE2b-256	`2cbe3d4f916ad5953a67803b7bba5d99c00dc6bb9f903c4beb2a13aaaad3a990`

See more details on using hashes here.

Provenance

The following attestation bundles were made for jenkinsapi-0.3.17-py3-none-any.whl:

Publisher: release.yml on pycontribs/jenkinsapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: jenkinsapi-0.3.17-py3-none-any.whl
- Subject digest: 3f12733b60e86e6f06c06756e9d10eb3cc5bd7fb3eeb0e04104200d3a68d8eac
- Sigstore transparency entry: 660064337
- Sigstore integration time: Nov 1, 2025
Source repository:
- Permalink: pycontribs/jenkinsapi@14d9d421401f0c1e912818205ae18a37e53ea288
- Branch / Tag: refs/tags/0.3.17
- Owner: https://github.com/pycontribs
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@14d9d421401f0c1e912818205ae18a37e53ea288
- Trigger Event: release

jenkinsapi 0.3.17

Navigation

Verified details

Maintainers

Unverified details

Meta

Classifiers

Project description

Installation

Important Links

About this library

Get details of jobs running on Jenkins server

Disable/Enable a Jenkins Job

Known issues

Development

Python versions

Jenkins versions

Project Contributors

Project details

Verified details

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance