Metadata-Version: 2.1
Name: im-jenkins-utils
Version: 1.2.0
Summary: Utilities for Informatics Matters CI/CD configuration
Home-page: https://github.com/InformaticsMatters/jenkins-utils
Author: Alan Christie
Author-email: achristie@informaticsmatters.com
License: Copyright (C) 2018 Informatics Matters Ltd. All rights reserved.
Keywords: jenkins
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3, <4
Requires-Dist: python-jenkins (==1.3.*)

Informatics Matters Jenkins Utilities
=====================================

.. image:: https://travis-ci.org/InformaticsMatters/jenkins-utils.svg?branch=master
   :target: https://travis-ci.org/InformaticsMatters/jenkins-utils

.. image:: https://badge.fury.io/py/im-jenkins-utils.svg
   :target: https://badge.fury.io/py/im-jenkins-utils

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()

.. _Informatics Matters: http://www.informaticsmatters.com
.. _python-jenkins: https://pypi.org/project/python-jenkins


