Metadata-Version: 2.0
Name: pyjen
Version: 0.0.1dev
Summary: Python wrapper for the Jenkins CI REST API
Home-page: https://github.com/TheFriendlyCoder/pyjen
Author: Kevin S. Phillips
Author-email: kevin@thefriendlycoder.com
License: GPL
Platform: UNKNOWN
Requires-Dist: requests (>=2.0.1)

.. 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 CI(http://jenkins-ci.org/) 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.

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 accessed, analyzed and even modified or created
via simple Python commands.


Example: Displaying 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()


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


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


