Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updates

  • Loading branch information...
commit 4531063dc7e9f8e31e708e717dfdc69cc6d858c0 1 parent 3b102a3
@AndreCharbonneau AndreCharbonneau authored
View
153 doc/Makefile
@@ -0,0 +1,153 @@
+# 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) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> 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 " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @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/Cloudbatchcomputingservices.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Cloudbatchcomputingservices.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/Cloudbatchcomputingservices"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Cloudbatchcomputingservices"
+ @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."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
View
242 doc/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# Cloud batch computing services documentation build configuration file, created by
+# sphinx-quickstart on Mon Apr 8 16:32:39 2013.
+#
+# 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
+
+# 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', 'sphinx.ext.todo']
+
+# 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'Cloud batch computing services'
+copyright = u'2013, UVIC HEP Group'
+
+# 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.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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
+# "<project> v<release> 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 <link> 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 = 'Cloudbatchcomputingservicesdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Cloudbatchcomputingservices.tex', u'Cloud batch computing services Documentation',
+ u'UVIC HEP Group', '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
+
+# 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', 'cloudbatchcomputingservices', u'Cloud batch computing services Documentation',
+ [u'UVIC HEP Group'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'Cloudbatchcomputingservices', u'Cloud batch computing services Documentation',
+ u'UVIC HEP Group', 'Cloudbatchcomputingservices', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
View
22 doc/index.rst
@@ -0,0 +1,22 @@
+.. Cloud batch computing services documentation master file, created by
+ sphinx-quickstart on Mon Apr 8 16:32:39 2013.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Cloud batch computing services's documentation!
+==========================================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
View
12 wsgi/rpi_web.py
@@ -24,9 +24,6 @@
try:
- cloudSchedulerService = CloudSchedulerService()
-
-
logging.debug('Creating request dispatching routes...')
d = cherrypy.dispatch.RoutesDispatcher()
m = d.mapper
@@ -35,8 +32,13 @@
conf['/'] = {'request.dispatch': d}
- # URL Routes go here:
- d.connect('cloud-scheduler-info', '/service/info', controller = cloudSchedulerService, action = 'info')
+ # Create the handlers.
+ cloudSchedulerService = CloudSchedulerService()
+
+
+ # Connect the handler's routes.
+ cloudSchedulerService.connectRoutes(d)
+
View
45 wsgi/services/base.py
@@ -2,12 +2,20 @@
import datetime
import json
import logging
+from utils import HtmlUtils
class RpiService():
"""
An abstract base class for all services.
"""
+ #
+ # URL routes handlers.
+ # The following route handlers will be called when specific URLs are visited.
+ # These methods will call the subclass's methods to get the information and then
+ # format it properly (i.e., json or html) before returning it to the caller.
+ #
+
def info(self):
"""
Return basic identification and provenance information about
@@ -30,7 +38,7 @@ def info(self):
The value of "version" will be taken as a string and can
follow any versioning scheme you deem appropriate.
- The value of "releaseTime" is in the format ddd mmm dd yyyy
+ The value of "dt" is in the format ddd mmm dd yyyy
HH:MM:ss (example Sat Jun 09 2007 17:46:21). Please express in
UTC rather than local time.
@@ -47,13 +55,15 @@ def info(self):
d['synopsis'] = self.getSynopsis()
d['version'] = self.getVersion()
d['institution'] = self.getInstitution()
- # TODO: Convert datetime to UTC
- d['releaseTime'] = self.getReleaseTime().strftime('%a %b %d %Y %H:%M:%S')
+ dt = self.getReleaseTime()
+ if (dt.tzinfo != None) and (dt.utcoffset() != None):
+ dt = dt.astimezone(pytz.utc)
+ d['releaseTime'] = dt.strftime('%a %b %d %Y %H:%M:%S')
if acceptHeader == 'application/json':
return json.dumps(d)
else:
- return """<html><pre>%s</pre></html>""" % (d)
+ return HtmlUtils().dictToPage(d)
def stats(self):
@@ -86,13 +96,16 @@ def stats(self):
"""
acceptHeader = cherrypy.lib.cptools.accept()
d = {}
- d['invocations'] = self.getInvocations()
- d['lastReset'] = self.getLastReset()
+ d['invocations'] = str(self.getInvocations())
+ dt = self.getLastReset()
+ if (dt.tzinfo != None) and (dt.utcoffset() != None):
+ dt = dt.astimezone(pytz.utc)
+ d['lastReset'] = dt.strftime('%a %b %d %Y %H:%M:%S')
if acceptHeader == 'application/json':
return json.dumps(d)
else:
- return """<html><pre>%s</pre></html>""" % (d)
+ return HtmlUtils().dictToPage(d)
def doc(self):
@@ -170,18 +183,31 @@ def tryme(self):
+ def connectRoutes(self, d):
+ d.connect(self.__class__.__name__ + '-info', '/service/info', controller = self, action = 'info')
+ d.connect(self.__class__.__name__ + '-stats', '/service/stats', controller = self, action = 'stats')
+ d.connect(self.__class__.__name__ + '-doc', '/service/doc', controller = self, action = 'doc')
+ d.connect(self.__class__.__name__ + '-releasenotes', '/service/releasenotes', controller = self, action = 'releasenotes')
+ d.connect(self.__class__.__name__ + '-support', '/service/support', controller = self, action = 'support')
+ d.connect(self.__class__.__name__ + '-source', '/service/source', controller = self, action = 'source')
+ d.connect(self.__class__.__name__ + '-tryme', '/service/tryme', controller = self, action = 'tryme')
+
+
+
+ #
# The following abastract methods needs to be implemented in
# each RPI service subclasses.
# These are defined in the "RPI API Enhancements for CANARIE
# Service Registry and Monitoring System" document.
+ #
def getName(self):
- raise NotImplementedError()
+ return self.__class__.__name__
def getSynopsis(self):
raise NotImplementedError()
@@ -202,6 +228,9 @@ def getInvocations(self):
raise NotImplementedError()
def getLastReset(self):
+ """
+ Must return a datetime.datetime object.
+ """
raise NotImplementedError()
def getDoc(self):
View
14 wsgi/services/cloudscheduler.py
@@ -2,9 +2,6 @@
import datetime
class CloudSchedulerService(RpiService):
- def getName(self):
- return 'CloudScheduler'
-
def getSynopsis(self):
return 'A service to schedule work between clouds.'
@@ -21,10 +18,10 @@ def getReleaseTime(self):
return datetime.datetime.now()
def getInvocations(self):
- raise NotImplementedError()
+ return 0
def getLastReset(self):
- raise NotImplementedError()
+ return datetime.datetime.now()
def getDoc(self):
return 'This is the service documentation page.'
@@ -32,4 +29,11 @@ def getDoc(self):
def getReleaseNotes(self):
return 'These are the release notes.'
+ def getSupport(self):
+ return 'These are the support notes.'
+ def getSource(self):
+ return 'https://github.com/hep-gc/cloud-scheduler'
+
+ def getTryMe(self):
+ return '[Under Construction]'
View
18 wsgi/services/utils.py
@@ -0,0 +1,18 @@
+import cgi
+
+class HtmlUtils():
+ """
+ Very simple class to create simple html pages to return to the client.
+ Here we chose to implement it as opposed to adding a dependency to a
+ library or framework.
+ """
+ def dictToPage(self, d, title=''):
+ return '<html><head><title>%s</title></head><body>%s</body></html>' % (title, self.dictToTable(d))
+
+ def dictToTable(self, d):
+ html = '<table>'
+ for key in d.keys():
+ html += '<tr><th align=right>%s:</th><td>%s</td></tr>' % (cgi.escape(key), cgi.escape(d[key]))
+ html += '</table>'
+ return html
+
Please sign in to comment.
Something went wrong with that request. Please try again.