Metadata-Version: 2.1
Name: pyjen
Version: 0.0.15.139.dev0
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
Keywords: jenkins jenkins-ci api wrapper library
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries
Provides-Extra: dev
Requires-Dist: requests[security] (>=2.0.1)
Requires-Dist: six
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: wheel; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: mock; extra == 'dev'
Requires-Dist: radon; extra == 'dev'
Requires-Dist: pylint; extra == 'dev'
Requires-Dist: sphinx (>=1.2.3); extra == 'dev'
Requires-Dist: tox; extra == 'dev'

.. 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
=============

.. image:: https://img.shields.io/pypi/l/pyjen.svg
    :target: https://pypi.python.org/pypi/pyjen/
    :alt: License

.. image:: https://img.shields.io/pypi/pyversions/pyjen.svg
    :target: https://pypi.python.org/pypi/pyjen/
    :alt: Python Versions

.. image:: https://img.shields.io/pypi/dm/pyjen.svg
    :target: https://pypi.python.org/pypi/pyjen/
    :alt: Downloads

.. image:: https://img.shields.io/pypi/format/pyjen.svg
    :target: https://pypi.python.org/pypi/pyjen/
    :alt: Format

.. image:: https://badge.fury.io/py/pyjen.svg
    :target: https://pypi.python.org/pypi/pyjen/
    :alt: Latest Version

.. image:: https://api.travis-ci.org/TheFriendlyCoder/pyjen.svg?branch=master
    :target: https://travis-ci.org/TheFriendlyCoder/pyjen
    :alt: Build status

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 on `ReadTheDocs.org <http://pyjen.readthedocs.org/en/v0.0.10dev/>`_.

=================
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 --pre

3. import the pyjen module and start scripting! See below for some common examples.

For a more in-depth guide to contributing to the project, see our 
`contributors guide <https://pyjen.readthedocs.org/en/v0.0.10dev/contrib_guide.html>`_.

================
Examples
================
Display a list of all jobs on the default view
------------------------------------------------------------

::

    from pyjen.jenkins import Jenkins
    jk = Jenkins("http://localhost:8080")
    vw = jk.default_view
    jobs = vw.jobs

    for j in jobs:
        print(j.name)


Disable all jobs in a view named "My View"
---------------------------------------------------------

::

    from pyjen.jenkins import Jenkins
    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.jenkins import Jenkins
    jen = Jenkins("http://localhost:8080")
    jb = jen.find_job("JobA")
    upstream = jb.all_upstream_jobs

    for u in upstream:
        print(u.name)

Clone all jobs in a view who are named with a 'trunk' identifier for a new branch configuration
------------------------------------------------------------------------------------------------

::

    from pyjen.jenkins import Jenkins
    j = Jenkins("http://localhost:8080")
    v = j.find_view("trunk_builds")
    v.clone_all_jobs("trunk", "branch")


