Skip to main content
https://travis-ci.com/InformaticsMatters/jenkins-utils.svg?branch=master https://badge.fury.io/py/im-jenkins-utils.svg

The im-jenkins-utils module is a set of utilities employed by Informatics Matters for automated configuration of the Jenkins CI/CD platform. It is a small library that currently simplifies the creation of Jobs, secrets and other actions using python-jenkins and cURL.

It also includes a growing list of convenient wrapper functions to simplify a number of tasks, like checking whether any jobs have failed (or are unstable).

Typical use of the utilities relies on creating an ImJenkinsServer object by providing a suitably formatted URL:

from im_jenkins_server import ImJenkinsServer
j_server = ImJenkinsServer(url)

The url value is typically of the form https://<user>:<token>@<url>.

With this object you can then create a global text secret:

if j_server.is_connected():
    j_server.set_secret_text('mySecretId', 'The Secret Text')

ImJenkinsServer provides the following methods: -

  • set_secret_text()

  • set_secret_file()

  • set_secret_user()

  • get_jobs()

  • set_jobs()

  • get_views()

  • set_views()

  • check_jobs()

Configuration

You can provide configuration in a Python ConfigParser-style file.

At the moment this is used to provide a list of Jenkins Jobs that are excluded during the check_jobs() method. If there are Jobs that can fail, that you’re not interested in, then you can provide their names via a configuration file.

To exclude Jobs Build (Experiment) and Run (Experiment) you can provide their names in the check section using the exclude-job key:

[check]
exclude-job: Build (Experiment)
    Run (Experiment)

And then pass the name and path of the configuration file to the server object:

j_server = ImJenkinsServer(url, 'config.ini')

Jobs are assumed to be tolerant of case and the Job names are checked while ignoring the name case.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

im_jenkins_utils-1.3.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file im_jenkins_utils-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: im_jenkins_utils-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.7

File hashes

Hashes for im_jenkins_utils-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5428fa2e3674610f7981820291fe1fcc0170b863637dee057037594d2cca3670
MD5 871ad18d6079ef6e3fab90b453f628d2
BLAKE2b-256 83c332381beed573222fc50be87e8cb15832f5e8c5b60848748114fea5eb0e75

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.3.0 This release

1 file

1.2.0

1 file

1.1.3

1 file

1.1.2

1 file

1.1.1

1 file

1.1.0

1 file

1.0.2

1 file

1.0.1

1 file

1.0.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page