<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Python Jenkins — Python Jenkins 0.4.15 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API reference" href="api.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API reference"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Python Jenkins 0.4.15 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="python-jenkins">
<h1>Python Jenkins<a class="headerlink" href="#python-jenkins" title="Permalink to this headline">¶</a></h1>
</div>
<div class="section" id="readme">
<h1>README<a class="headerlink" href="#readme" title="Permalink to this headline">¶</a></h1>
<p>Python Jenkins is a python wrapper for the <a class="reference external" href="http://jenkins-ci.org/">Jenkins</a>
REST API which aims to provide a more conventionally pythonic way of controlling
a Jenkins server. It provides a higher-level API containing a number of
convenience functions.</p>
<p>We like to use python-jenkins to automate our Jenkins servers. Here are some of
the things you can use it for:</p>
<ul class="simple">
<li>Create new jobs</li>
<li>Copy existing jobs</li>
<li>Delete jobs</li>
<li>Update jobs</li>
<li>Get a job’s build information</li>
<li>Get Jenkins master version information</li>
<li>Get Jenkins plugin information</li>
<li>Start a build on a job</li>
<li>Create nodes</li>
<li>Enable/Disable nodes</li>
<li>Get information on nodes</li>
<li>Create/delete/reconfig views</li>
<li>Put server in shutdown mode (quiet down)</li>
<li>List running builds</li>
<li>Create/delete/update folders <a class="footnote-reference" href="#f1" id="id1">[1]</a></li>
<li>Set the next build number <a class="footnote-reference" href="#f2" id="id2">[2]</a></li>
<li>Install plugins</li>
<li>and many more..</li>
</ul>
<p>To install:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo python setup.py install
</pre></div>
</div>
<p>Online documentation:</p>
<ul class="simple">
<li><a class="reference external" href="http://python-jenkins.readthedocs.org/en/latest/">http://python-jenkins.readthedocs.org/en/latest/</a></li>
</ul>
<div class="section" id="developers">
<h2>Developers<a class="headerlink" href="#developers" title="Permalink to this headline">¶</a></h2>
<p>Bug report:</p>
<ul class="simple">
<li><a class="reference external" href="https://bugs.launchpad.net/python-jenkins">https://bugs.launchpad.net/python-jenkins</a></li>
</ul>
<p>Repository:</p>
<ul class="simple">
<li><a class="reference external" href="https://git.openstack.org/cgit/openstack/python-jenkins">https://git.openstack.org/cgit/openstack/python-jenkins</a></li>
</ul>
<p>Cloning:</p>
<ul class="simple">
<li>git clone <a class="reference external" href="https://git.openstack.org/openstack/python-jenkins">https://git.openstack.org/openstack/python-jenkins</a></li>
</ul>
<p>Patches are submitted via Gerrit at:</p>
<ul class="simple">
<li><a class="reference external" href="https://review.openstack.org/">https://review.openstack.org/</a></li>
</ul>
<p>Please do not submit GitHub pull requests, they will be automatically closed.</p>
<p>More details on how you can contribute is available on our wiki at:</p>
<ul class="simple">
<li><a class="reference external" href="http://docs.openstack.org/infra/manual/developers.html">http://docs.openstack.org/infra/manual/developers.html</a></li>
</ul>
</div>
<div class="section" id="writing-a-patch">
<h2>Writing a patch<a class="headerlink" href="#writing-a-patch" title="Permalink to this headline">¶</a></h2>
<p>We ask that all code submissions be <a class="reference external" href="https://pypi.python.org/pypi/flake8">flake8</a> clean. The
easiest way to do that is to run <a class="reference external" href="https://testrun.org/tox">tox</a> before submitting code for
review in Gerrit. It will run <code class="docutils literal notranslate"><span class="pre">flake8</span></code> in the same
manner as the automated test suite that will run on proposed
patchsets.</p>
</div>
<div class="section" id="installing-without-setup-py">
<h2>Installing without setup.py<a class="headerlink" href="#installing-without-setup-py" title="Permalink to this headline">¶</a></h2>
<p>Then install the required python packages using <a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install python-jenkins
</pre></div>
</div>
<p class="rubric">Footnotes</p>
<table class="docutils footnote" frame="void" id="f1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>The free <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/CloudBees+Folders+Plugin">Cloudbees Folders Plugin</a>
provides support for a subset of the full folders functionality. For the
complete capabilities you will need the paid for version of the plugin.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="f2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>The <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Next+Build+Number+Plugin">Next Build Number Plugin</a>
provides support for setting the next build number.</td></tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Using Python-Jenkins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-1-get-version-of-jenkins">Example 1: Get version of Jenkins</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-2-logging-into-jenkins-using-kerberos">Example 2: Logging into Jenkins using kerberos</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-3-working-with-jenkins-jobs">Example 3: Working with Jenkins Jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-4-working-with-jenkins-views">Example 4: Working with Jenkins Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-5-working-with-jenkins-plugins">Example 5: Working with Jenkins Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-6-working-with-jenkins-nodes">Example 6: Working with Jenkins Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-7-working-with-jenkins-build-queue">Example 7: Working with Jenkins Build Queue</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-8-working-with-jenkins-cloudbees-folders">Example 8: Working with Jenkins Cloudbees Folders</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-9-updating-next-build-number">Example 9: Updating Next Build Number</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-9-working-with-build-promotions">Example 9: Working with Build Promotions</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#example-10-waiting-for-jenkins-to-be-ready">Example 10: Waiting for Jenkins to be ready</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#unit-tests">Unit Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#test-coverage">Test Coverage</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Python Jenkins</a></li>
<li><a class="reference internal" href="#readme">README</a><ul>
<li><a class="reference internal" href="#developers">Developers</a></li>
<li><a class="reference internal" href="#writing-a-patch">Writing a patch</a></li>
<li><a class="reference internal" href="#installing-without-setup-py">Installing without setup.py</a></li>
</ul>
</li>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="api.html"
title="next chapter">API reference</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API reference"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Python Jenkins 0.4.15 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010, Willow Garage.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
f4c39736165fb5de6c035ac134b76c07
>
files
>
62
