Python wrapper for the Jenkins CI REST API
Project description
.. This is a readme file encoded in reStructuredText format, intended for use on the summary page for the pyjen
.. PyPI project. Care should be taken to make sure the encoding is compatible with PyPI's markup
.. syntax. See this site for details:
.. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
..
=============
Overview
=============
Extensible, user and developer friendly Python interface to the `Jenkins <http://jenkins-ci.org/>`_ CI tool, wrapping
the features exposed by the standard REST `API <https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API/>`_ using
Pythonic objects and functions. Tested against the latest 2.x and 3.x versions of Python, and the
latest trunk and LTS editions of Jenkins.
With an intuitive and well thought out interface, PyJen offers anyone familiar with the Python programming
language an easy way to manage Jenkins dashboards from a simple command prompt. All core primitives of Jenkins,
including views, jobs and builds are easily accessible and can be loaded, analyzed and even modified or created
via simple Python commands.
Comments, suggestions and bugs may be reported to the project `maintainer <mailto:kevin@thefriendlycoder.com>`_
Full API documentation can be found `here <http://www.thefriendlycoder.com/PyJen>`_.
=================
Quick start guide
=================
1. First, we recommend that you install the pip package manager as described `here <http://www.pip-installer.org/en/latest/installing.html>`_
2. Install PyJen directly from PyPI using PIP:
::
# pip install pyjen
3. import the pyjen module and start scripting! See below for some common examples.
================
Examples
================
Display a list of all jobs on the default view
------------------------------------------------------------
::
from pyjen import *
jk = jenkins("http://localhost:8080")
vw = jk.get_default_view()
jobs = vw.get_jobs()
for j in jobs:
print j.get_name()
Disable all jobs in a view named "My View"
---------------------------------------------------------
::
from pyjen import *
jk = jenkins("http://localhost:8080")
vw = jk.find_view("My View")
vw.disable_all_jobs()
Get all upstream dependencies of a job named "JobA"
------------------------------------------------------------
::
from pyjen import *
j = job("http://localhost:8080/job/JobA")
upstream = j.get_upstream_jobs(True)
for u in upstream:
print u.get_name()
Clone all jobs in a view who are named with a 'trunk' identifier for a new branch configuration
------------------------------------------------------------------------------------------------
::
from pyjen import *
v = view("http://localhost:8080/views/trunk_builds")
v.clone_all_jobs(".*trunk.*", "branch")
.. PyPI project. Care should be taken to make sure the encoding is compatible with PyPI's markup
.. syntax. See this site for details:
.. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
..
=============
Overview
=============
Extensible, user and developer friendly Python interface to the `Jenkins <http://jenkins-ci.org/>`_ CI tool, wrapping
the features exposed by the standard REST `API <https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API/>`_ using
Pythonic objects and functions. Tested against the latest 2.x and 3.x versions of Python, and the
latest trunk and LTS editions of Jenkins.
With an intuitive and well thought out interface, PyJen offers anyone familiar with the Python programming
language an easy way to manage Jenkins dashboards from a simple command prompt. All core primitives of Jenkins,
including views, jobs and builds are easily accessible and can be loaded, analyzed and even modified or created
via simple Python commands.
Comments, suggestions and bugs may be reported to the project `maintainer <mailto:kevin@thefriendlycoder.com>`_
Full API documentation can be found `here <http://www.thefriendlycoder.com/PyJen>`_.
=================
Quick start guide
=================
1. First, we recommend that you install the pip package manager as described `here <http://www.pip-installer.org/en/latest/installing.html>`_
2. Install PyJen directly from PyPI using PIP:
::
# pip install pyjen
3. import the pyjen module and start scripting! See below for some common examples.
================
Examples
================
Display a list of all jobs on the default view
------------------------------------------------------------
::
from pyjen import *
jk = jenkins("http://localhost:8080")
vw = jk.get_default_view()
jobs = vw.get_jobs()
for j in jobs:
print j.get_name()
Disable all jobs in a view named "My View"
---------------------------------------------------------
::
from pyjen import *
jk = jenkins("http://localhost:8080")
vw = jk.find_view("My View")
vw.disable_all_jobs()
Get all upstream dependencies of a job named "JobA"
------------------------------------------------------------
::
from pyjen import *
j = job("http://localhost:8080/job/JobA")
upstream = j.get_upstream_jobs(True)
for u in upstream:
print u.get_name()
Clone all jobs in a view who are named with a 'trunk' identifier for a new branch configuration
------------------------------------------------------------------------------------------------
::
from pyjen import *
v = view("http://localhost:8080/views/trunk_builds")
v.clone_all_jobs(".*trunk.*", "branch")
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyjen-0.0.2dev.tar.gz
(20.7 kB
view hashes)
