From 0e3f41e53a3cbc09e26f7dbfe3becfa413a4d16a Mon Sep 17 00:00:00 2001 From: "Ken Conley kwc@willowgarage.com" <> Date: Sat, 3 Sep 2011 17:00:30 -0700 Subject: [PATCH] Converting documentation to sphinx --- doc/Makefile | 130 ++++++++++++++++++++++++++ doc/conf.py | 219 ++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 39 ++++++++ jenkins/__init__.py | 131 +++++++++++++------------- 4 files changed, 454 insertions(+), 65 deletions(-) create mode 100644 doc/Makefile create mode 100644 doc/conf.py create mode 100644 doc/index.rst diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..5d450d1 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonJenkins.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonJenkins.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonJenkins" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonJenkins" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..26f65bc --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,219 @@ +# -*- coding: utf-8 -*- +# +# Python Jenkins documentation build configuration file, created by +# sphinx-quickstart on Sat Sep 3 16:24:58 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +import sys, os +sys.path.insert(0, os.path.abspath('..')) + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Python Jenkins' +copyright = u'2010, Willow Garage' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.2' +# The full version, including alpha/beta/rc tags. +release = '0.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PythonJenkinsdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'PythonJenkins.tex', u'Python Jenkins Documentation', + u'Ken Conley, James Page, Tully Foote, Matthew Gertner', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pythonjenkins', u'Python Jenkins Documentation', + [u'Ken Conley, James Page, Tully Foote, Matthew Gertner'], 1) +] diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..37d7c2d --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,39 @@ +Welcome to Python Jenkins's documentation! +========================================== + +Python Jenkins is a library for the remote API of the `Jenkins +`_ continuous integration server. It is useful +for creating and managing jobs as well as build nodes. + +Python Jenkins development is hosted on Launchpad: https://launchpad.net/python-jenkins + +Installing +========== + +``pip``:: + + pip install python-jenkins + +``easy_install``:: + + easy_install python-jenkins + +Ubuntu Oneiric or later:: + + apt-get install python-jenkins + + +API documentation +================= + +.. automodule:: jenkins +.. autoclass:: jenkins.Jenkins + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/jenkins/__init__.py b/jenkins/__init__.py index 4de9351..479930e 100644 --- a/jenkins/__init__.py +++ b/jenkins/__init__.py @@ -40,20 +40,21 @@ ''' Python API for Jenkins -Examples: +Examples:: - jenkins.get_jobs() - jenkins.create_job('empty', EMPTY_CONFIG_XML) - jenkins.disable_job('empty') - jenkins.copy_job('empty', 'empty_copy') - jenkins.enable_job('empty_copy') - jenkins.reconfig_job('empty_copy', RECONFIG_XML) + j = jenkins.Jenkins('http://your_url_here', 'username', 'password') + j.get_jobs() + j.create_job('empty', jenkins.EMPTY_CONFIG_XML) + j.disable_job('empty') + j.copy_job('empty', 'empty_copy') + j.enable_job('empty_copy') + j.reconfig_job('empty_copy', jenkins.RECONFIG_XML) - jenkins.delete_job('empty') - jenkins.delete_job('empty_copy') + j.delete_job('empty') + j.delete_job('empty_copy') # build a parameterized job - jenkins.build_job('api-test', {'param1': 'test value 1', 'param2': 'test value 2'}) + j.build_job('api-test', {'param1': 'test value 1', 'param2': 'test value 2'}) ''' import sys @@ -119,7 +120,11 @@ RECONFIG_XML = ''' ''' -class JenkinsException(Exception): pass +class JenkinsException(Exception): + ''' + General exception type for jenkins-API-related failures. + ''' + pass def auth_headers(username, password): ''' @@ -133,8 +138,7 @@ class Jenkins(object): ''' Create handle to Jenkins instance. - @param url: URL of Jenkins server - @type url: str + :param url: URL of Jenkins server, ``str`` ''' if url[-1] == '/': self.server = url @@ -166,7 +170,8 @@ class Jenkins(object): def jenkins_open(self, req): ''' - Utility routine for opening an HTTP request to a Jenkins server. + Utility routine for opening an HTTP request to a Jenkins server. This should only be used + to extends the :class:`Jenkins` API. ''' try: if self.auth: @@ -180,7 +185,12 @@ class Jenkins(object): def get_queue_info(self): ''' - @return: list of job dictionaries + :returns: list of job dictionaries, ``[dict]`` + + Example:: + >>> queue_info = j.get_queue_info() + >>> print(queue_info[0]) + {u'task': {u'url': u'http://your_url/job/my_job/', u'color': u'aborted_anime', u'name': u'my_job'}, u'stuck': False, u'actions': [{u'causes': [{u'shortDescription': u'Started by timer'}]}], u'buildable': False, u'params': u'', u'buildableStartMilliseconds': 1315087293316, u'why': u'Build #2,532 is already in progress (ETA:10 min)', u'blocked': True} ''' return json.loads(self.jenkins_open(urllib2.Request(self.server + Q_INFO)))['items'] @@ -189,8 +199,15 @@ class Jenkins(object): Get information on this Hudson server. This information includes job list and view information. - @return: dictionary of information about Hudson server - @rtype: dict + :returns: dictionary of information about Hudson server, ``dict`` + + Example:: + + >>> info = j.get_info() + >>> jobs = info['jobs'] + >>> print(jobs[0]) + {u'url': u'http://your_url_here/job/my_job/', u'color': u'blue', u'name': u'my_job'} + """ try: return json.loads(self.jenkins_open(urllib2.Request(self.server + INFO))) @@ -206,8 +223,7 @@ class Jenkins(object): Get list of jobs running. Each job is a dictionary with 'name', 'url', and 'color' keys. - @return: list of jobs - @rtype: [ { str: str} ] + :returns: list of jobs, ``[ { str: str} ]`` """ return self.get_info()['jobs'] @@ -215,10 +231,8 @@ class Jenkins(object): ''' Copy a Jenkins job - @param from_name: Name of Jenkins job to copy from - @type from_name: str - @param to_name: Name of Jenkins job to copy to - @type to_name: str + :param from_name: Name of Jenkins job to copy from, ``str`` + :param to_name: Name of Jenkins job to copy to, ``str`` ''' self.get_job_info(from_name) self.jenkins_open(urllib2.Request(self.server + COPY_JOB%locals(), '')) @@ -229,8 +243,7 @@ class Jenkins(object): ''' Delete Jenkins job permanently. - @param name: Name of Jenkins job - @type name: str + :param name: Name of Jenkins job, ``str`` ''' self.get_job_info(name) self.jenkins_open(urllib2.Request(self.server + DELETE_JOB%locals(), '')) @@ -241,27 +254,24 @@ class Jenkins(object): ''' Enable Jenkins job. - @param name: Name of Jenkins job - @type name: str + :param name: Name of Jenkins job, ``str`` ''' self.get_job_info(name) self.jenkins_open(urllib2.Request(self.server + ENABLE_JOB%locals(), '')) def disable_job(self, name): ''' - Disable Jenkins job. To re-enable, call enable_job(). + Disable Jenkins job. To re-enable, call :meth:`Jenkins.enable_job`. - @param name: Name of Jenkins job - @type name: str + :param name: Name of Jenkins job, ``str`` ''' self.get_job_info(name) self.jenkins_open(urllib2.Request(self.server + DISABLE_JOB%locals(), '')) def job_exists(self, name): ''' - @param name: Name of Jenkins job - @type name: str - @return: True if Jenkins job exists + :param name: Name of Jenkins job, ``str`` + :returns: ``True`` if Jenkins job exists ''' try: self.get_job_info(name) @@ -273,10 +283,8 @@ class Jenkins(object): ''' Create a new Jenkins job - @param name: Name of Jenkins job - @type name: str - @param config_xml: config file text - @type config_xml: str + :param name: Name of Jenkins job, ``str`` + :param config_xml: config file text, ``str`` ''' if self.job_exists(name): raise JenkinsException('job[%s] already exists'%(name)) @@ -290,20 +298,17 @@ class Jenkins(object): ''' Get configuration of existing Jenkins job. - @param name: Name of Jenkins job - @type name: str + :param name: Name of Jenkins job, ``str`` ''' get_config_url = self.server + CONFIG_JOB%locals() return self.jenkins_open(urllib2.Request(get_config_url)) def reconfig_job(self, name, config_xml): ''' - Change configuration of existing Jenkins job. + Change configuration of existing Jenkins job. To create a new job, see :meth:`Jenkins.create_job`. - @param name: Name of Jenkins job - @type name: str - @param config_xml: New XML configuration - @type config_xml: str + :param name: Name of Jenkins job, ``str`` + :param config_xml: New XML configuration, ``str`` ''' self.get_job_info(name) headers = {'Content-Type': 'text/xml'} @@ -312,8 +317,11 @@ class Jenkins(object): def build_job_url(self, name, parameters=None, token=None): ''' - @param parameters: parameters for job, or None. - @type parameters: dict + Get URL to trigger Hudson build job. Authenticated setups may require configuring a token on the server side. + + :param parameters: parameters for job, or None., ``dict`` + :param token: (optional) token for building job, ``str`` + :returns: URL for building job ''' if parameters: if token: @@ -326,8 +334,9 @@ class Jenkins(object): def build_job(self, name, parameters=None, token=None): ''' - @param parameters: parameters for job, or None. - @type parameters: dict + Trigger Hudson build job. + + :param parameters: parameters for job, or ``None``, ``dict`` ''' if not self.job_exists(name): raise JenkinsException('no such job[%s]'%(name)) @@ -347,9 +356,8 @@ class Jenkins(object): def node_exists(self, name): ''' - @param name: Name of Jenkins node - @type name: str - @return: True if Jenkins node exists + :param name: Name of Jenkins node, ``str`` + :returns: ``True`` if Jenkins node exists ''' try: self.get_node_info(name) @@ -361,8 +369,7 @@ class Jenkins(object): ''' Delete Jenkins node permanently. - @param name: Name of Jenkins node - @type name: str + :param name: Name of Jenkins node, ``str`` ''' self.get_node_info(name) self.jenkins_open(urllib2.Request(self.server + DELETE_NODE%locals(), '')) @@ -373,18 +380,12 @@ class Jenkins(object): def create_node(self, name, numExecutors=2, nodeDescription=None, remoteFS='/var/lib/jenkins', labels=None, exclusive=False): ''' - @param name: name of node to create - @type name: str - @param numExecutors: number of executors for node - @type numExecutors: int - @param nodeDescription: Description of node - @type nodeDescription: str - @param remoteFS: Remote filesystem location to use - @type remoteFS: str - @param labels: Labels to associate with node - @type labels: str - @param exclusive: Use this node for tied jobs onlu - @type exclusive: boolean + :param name: name of node to create, ``str`` + :param numExecutors: number of executors for node, ``int`` + :param nodeDescription: Description of node, ``str`` + :param remoteFS: Remote filesystem location to use, ``str`` + :param labels: Labels to associate with node, ``str`` + :param exclusive: Use this node for tied jobs only, ``bool`` ''' if self.node_exists(name): raise JenkinsException('node[%s] already exists'%(name))