Installation

From pypi

The easiest (and best) way to install is through pip:

$ python -m pip install api4jenkins

From source

Optional you can clone the public repository to install:

$ git clone https://github.com/joelee2012/api4jenkins
$ cd api4jenkins
$ python -m pip install .

Prerequisites

Install following plugins for Jenkins to enable full functionality for api4jenkins:

Release History

1.15.0 (2023-08-30)

  • Support to manage domains for credential

1.14.1 (2023-07-24)

  • Support additional session headers

1.14 (2022-11-28)

  • Add AnkaCloudComputer (#70)

  • Remove 3.6 support (#71)

1.13 (2022-10-01)

  • fix for approving the pending input when jenkins runs on subpath (#66)

  • support get build by display name for job (#63)

1.12 (2022-08-04)

  • Add EC2Computer as Node child class (#58)

1.11 (2022-07-08)

  • encode request data with utf-8

  • add parameter “recursive” for Job.duplicate

  • fix issue for Jenkins.crate_job

1.10 (2022-05-17)

  • recursively create parent of job if it does not exist

  • add buildable property for multibranchproject

  • set dependency version

1.9.1 (2022-03-29)

  • change OrganizationFolder to inherit from WorkflowMultiBranchProject

  • Jenkins.get_job return consistent result

1.9 (2022-03-12)

  • Resolve name, full_name, full_display_name from url for Job

  • Add new methods for Nodes, Project

  • Support SectionedView and OrganizationFolder

1.8 (2021-12-27)

1.7 (2021-10-09)

1.6 (2021-08-01)

  • Support NestedView

  • Support decrypt credential in Jenkins

  • Update doc

  • bugfix for queue.get_build

1.5.1 (2021-05-11)

  • Bugfix for nodes.iter_builds

1.5 (2021-04-29)

  • Add methods to get parameters and causes for Build and QueueItem

  • Add methods to manage jcasc

  • Add help functions

1.4 (2021-03-31)

  • Support to retrieve test report for build

  • Support to validate Jenkinsfile

1.3 (2021-02-28)

  • Add capability to get/save artifacts for WorkflowRun.

  • Make Jenkins and Folder is subscribed and can be iterated with depth.

  • Refactor some code.

1.2 (2021-01-31)

  • Support to enable, disable, scan, get_scan_log for WorkflowMultiBranchProject

  • Call Jenkins.get_job for getting parent of Job

  • Support process input step for WorkflowRun, see WorkflowRun.get_pending_input()

  • Support user management

1.1 (2020-12-31)

  • Rewrite documentation and add more examples

  • Jenkins.build_job() and Project.build() accept key word argments instead of dict

  • Support to access attribute with None type value in json

  • Fix typo in Folder.__iter__()

1.0 (2020-11-15)

  • First release