summaryrefslogtreecommitdiffstats
path: root/openstack
diff options
context:
space:
mode:
authorJason Kölker <jason@koelker.net>2011-09-27 13:44:51 -0500
committerJason Kölker <jason@koelker.net>2011-09-27 13:44:51 -0500
commit43b31973c0b7da171c0fd6bcbb56d8cc8326dca7 (patch)
treeee9d4d8105967ff2a6b5e68c2f51300519e4f6e4 /openstack
parent016e6ae629f1d8207f02aa05ad9236fccc203a92 (diff)
parentdbab61cd6bb070b5fc40a5fdc49b2caf3b20675a (diff)
downloadoslo-43b31973c0b7da171c0fd6bcbb56d8cc8326dca7.tar.gz
oslo-43b31973c0b7da171c0fd6bcbb56d8cc8326dca7.tar.xz
oslo-43b31973c0b7da171c0fd6bcbb56d8cc8326dca7.zip
Merge openstack-skeleton into templates
Diffstat (limited to 'openstack')
-rw-r--r--openstack/paste/templates/openstack/.gitignore2
-rw-r--r--openstack/paste/templates/openstack/README10
-rwxr-xr-xopenstack/paste/templates/openstack/bin/skeleton-api65
-rw-r--r--openstack/paste/templates/openstack/doc/Makefile97
-rw-r--r--openstack/paste/templates/openstack/doc/source/_static/basic.css416
-rw-r--r--openstack/paste/templates/openstack/doc/source/_static/default.css230
-rw-r--r--openstack/paste/templates/openstack/doc/source/_static/jquery.tweet.js154
-rw-r--r--openstack/paste/templates/openstack/doc/source/_static/tweaks.css65
-rw-r--r--openstack/paste/templates/openstack/doc/source/_templates/.placeholder0
-rw-r--r--openstack/paste/templates/openstack/doc/source/_theme/layout.html86
-rw-r--r--openstack/paste/templates/openstack/doc/source/_theme/theme.conf5
-rw-r--r--openstack/paste/templates/openstack/doc/source/conf.py252
-rw-r--r--openstack/paste/templates/openstack/doc/source/index.rst53
-rw-r--r--openstack/paste/templates/openstack/etc/skeleton-api.conf37
-rw-r--r--openstack/paste/templates/openstack/openstack/__init__.py16
-rw-r--r--openstack/paste/templates/openstack/openstack/common/__init__.py19
-rw-r--r--openstack/paste/templates/openstack/openstack/common/config.py333
-rw-r--r--openstack/paste/templates/openstack/openstack/common/context.py40
-rw-r--r--openstack/paste/templates/openstack/openstack/common/exception.py143
-rw-r--r--openstack/paste/templates/openstack/openstack/common/middleware/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/openstack/common/middleware/context.py64
-rw-r--r--openstack/paste/templates/openstack/openstack/common/utils.py89
-rw-r--r--openstack/paste/templates/openstack/openstack/common/wsgi.py353
-rw-r--r--openstack/paste/templates/openstack/setup.cfg9
-rw-r--r--openstack/paste/templates/openstack/setup.py89
-rw-r--r--openstack/paste/templates/openstack/skeleton/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/skeleton/api/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/skeleton/api/middleware/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/skeleton/api/v1/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/skeleton/version.py49
-rw-r--r--openstack/paste/templates/openstack/tests/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/tests/functional/__init__.py0
-rw-r--r--openstack/paste/templates/openstack/tests/unit/__init__.py0
33 files changed, 2676 insertions, 0 deletions
diff --git a/openstack/paste/templates/openstack/.gitignore b/openstack/paste/templates/openstack/.gitignore
new file mode 100644
index 0000000..b948985
--- /dev/null
+++ b/openstack/paste/templates/openstack/.gitignore
@@ -0,0 +1,2 @@
+*.swp
+*.pyc
diff --git a/openstack/paste/templates/openstack/README b/openstack/paste/templates/openstack/README
new file mode 100644
index 0000000..bfabbe4
--- /dev/null
+++ b/openstack/paste/templates/openstack/README
@@ -0,0 +1,10 @@
+This is the OpenStack Skeleton project. It serves two main purposes:
+
+* As a template for new projects wanting to join the OpenStack project
+* As a proving ground for determining best practices and common code
+ for all OpenStack projects
+
+The skeleton project is designed to show a recommended set of modules
+for creating a simple WSGI server, with a versioned API, clean separation
+of modules, a standard way of structuring both unit and functional tests,
+configuration files, and documentation.
diff --git a/openstack/paste/templates/openstack/bin/skeleton-api b/openstack/paste/templates/openstack/bin/skeleton-api
new file mode 100755
index 0000000..0bed84a
--- /dev/null
+++ b/openstack/paste/templates/openstack/bin/skeleton-api
@@ -0,0 +1,65 @@
+#!/usr/bin/env python
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Simple Skeleton API Server
+"""
+
+import optparse
+import os
+import sys
+
+# If ../skeleton/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+ os.pardir,
+ os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'skeleton', '__init__.py')):
+ sys.path.insert(0, possible_topdir)
+
+from openstack.common import config
+from openstack.common import wsgi
+from skeleton import version
+
+
+def create_options(parser):
+ """
+ Sets up the CLI and config-file options that may be
+ parsed and program commands.
+
+ :param parser: The option parser
+ """
+ config.add_common_options(parser)
+ config.add_log_options(parser)
+
+
+if __name__ == '__main__':
+ oparser = optparse.OptionParser(version='%%prog %s'
+ % version.version_string())
+ create_options(oparser)
+ (options, args) = config.parse_options(oparser)
+
+ try:
+ conf, app = config.load_paste_app('skeleton-api', options, args,
+ config_dir='skeleton')
+
+ server = wsgi.Server()
+ server.start(app, int(conf['bind_port']), conf['bind_host'])
+ server.wait()
+ except RuntimeError, e:
+ sys.exit("ERROR: %s" % e)
diff --git a/openstack/paste/templates/openstack/doc/Makefile b/openstack/paste/templates/openstack/doc/Makefile
new file mode 100644
index 0000000..251a008
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/Makefile
@@ -0,0 +1,97 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXSOURCE = source
+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) $(SPHINXSOURCE)
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+.DEFAULT_GOAL = html
+
+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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @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)/*
+ -rm -rf nova.sqlite
+ if [ -f .autogenerated ] ; then \
+ cat .autogenerated | xargs rm ; \
+ rm .autogenerated ; \
+ fi
+
+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."
+
+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/nova.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+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/openstack/paste/templates/openstack/doc/source/_static/basic.css b/openstack/paste/templates/openstack/doc/source/_static/basic.css
new file mode 100644
index 0000000..d909ce3
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_static/basic.css
@@ -0,0 +1,416 @@
+/**
+ * Sphinx stylesheet -- basic theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+img {
+ border: 0;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li div.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.field-list ul {
+ padding-left: 1em;
+}
+
+.first {
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px 7px 0 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px 7px 0 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+div.admonition dl {
+ margin-bottom: 0;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 0;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd p {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dt:target, .highlight {
+ background-color: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.refcount {
+ color: #060;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+}
+
+td.linenos pre {
+ padding: 5px 0px;
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ margin-left: 0.5em;
+}
+
+table.highlighttable td {
+ padding: 0 0.5em 0 0.5em;
+}
+
+tt.descname {
+ background-color: transparent;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+
+tt.descclassname {
+ background-color: transparent;
+}
+
+tt.xref, a tt {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+ background-color: transparent;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
diff --git a/openstack/paste/templates/openstack/doc/source/_static/default.css b/openstack/paste/templates/openstack/doc/source/_static/default.css
new file mode 100644
index 0000000..c8091ec
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_static/default.css
@@ -0,0 +1,230 @@
+/**
+ * Sphinx stylesheet -- default theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: sans-serif;
+ font-size: 100%;
+ background-color: #11303d;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ background-color: #1c4e63;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 230px;
+}
+
+div.body {
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+}
+
+div.footer {
+ color: #ffffff;
+ width: 100%;
+ padding: 9px 0 9px 0;
+ text-align: center;
+ font-size: 75%;
+}
+
+div.footer a {
+ color: #ffffff;
+ text-decoration: underline;
+}
+
+div.related {
+ background-color: #133f52;
+ line-height: 30px;
+ color: #ffffff;
+}
+
+div.related a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar {
+}
+
+div.sphinxsidebar h3 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.4em;
+ font-weight: normal;
+ margin: 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h3 a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar h4 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 0;
+}
+
+div.sphinxsidebar p {
+ color: #ffffff;
+}
+
+div.sphinxsidebar p.topless {
+ margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px;
+ padding: 0;
+ color: #ffffff;
+}
+
+div.sphinxsidebar a {
+ color: #98dbcc;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #355f7c;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: left;
+ line-height: 130%;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Trebuchet MS', sans-serif;
+ background-color: #f2f2f2;
+ font-weight: normal;
+ color: #20435c;
+ border-bottom: 1px solid #ccc;
+ margin: 20px -20px 10px -20px;
+ padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #c60f0f;
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ background-color: #c60f0f;
+ color: white;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: left;
+ line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+ display: inline;
+}
+
+div.admonition p {
+ margin-bottom: 5px;
+}
+
+div.admonition pre {
+ margin-bottom: 5px;
+}
+
+div.admonition ul, div.admonition ol {
+ margin-bottom: 5px;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre {
+ padding: 5px;
+ background-color: #eeffcc;
+ color: #333333;
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
+}
+
+tt {
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
+}
+
+.warning tt {
+ background: #efc2c2;
+}
+
+.note tt {
+ background: #d6d6d6;
+}
diff --git a/openstack/paste/templates/openstack/doc/source/_static/jquery.tweet.js b/openstack/paste/templates/openstack/doc/source/_static/jquery.tweet.js
new file mode 100644
index 0000000..c93fea8
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_static/jquery.tweet.js
@@ -0,0 +1,154 @@
+(function($) {
+
+ $.fn.tweet = function(o){
+ var s = {
+ username: ["seaofclouds"], // [string] required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"]
+ list: null, //[string] optional name of list belonging to username
+ avatar_size: null, // [integer] height and width of avatar if displayed (48px max)
+ count: 3, // [integer] how many tweets to display?
+ intro_text: null, // [string] do you want text BEFORE your your tweets?
+ outro_text: null, // [string] do you want text AFTER your tweets?
+ join_text: null, // [string] optional text in between date and tweet, try setting to "auto"
+ auto_join_text_default: "i said,", // [string] auto text for non verb: "i said" bullocks
+ auto_join_text_ed: "i", // [string] auto text for past tense: "i" surfed
+ auto_join_text_ing: "i am", // [string] auto tense for present tense: "i was" surfing
+ auto_join_text_reply: "i replied to", // [string] auto tense for replies: "i replied to" @someone "with"
+ auto_join_text_url: "i was looking at", // [string] auto tense for urls: "i was looking at" http:...
+ loading_text: null, // [string] optional loading text, displayed while tweets load
+ query: null // [string] optional search query
+ };
+
+ if(o) $.extend(s, o);
+
+ $.fn.extend({
+ linkUrl: function() {
+ var returning = [];
+ var regexp = /((ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp,"<a href=\"$1\">$1</a>"));
+ });
+ return $(returning);
+ },
+ linkUser: function() {
+ var returning = [];
+ var regexp = /[\@]+([A-Za-z0-9-_]+)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp,"<a href=\"http://twitter.com/$1\">@$1</a>"));
+ });
+ return $(returning);
+ },
+ linkHash: function() {
+ var returning = [];
+ var regexp = / [\#]+([A-Za-z0-9-_]+)/gi;
+ this.each(function() {
+ returning.push(this.replace(regexp, ' <a href="http://search.twitter.com/search?q=&tag=$1&lang=all&from='+s.username.join("%2BOR%2B")+'">#$1</a>'));
+ });
+ return $(returning);
+ },
+ capAwesome: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'));
+ });
+ return $(returning);
+ },
+ capEpic: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/\b(epic)\b/gi, '<span class="epic">$1</span>'));
+ });
+ return $(returning);
+ },
+ makeHeart: function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(/(&lt;)+[3]/gi, "<tt class='heart'>&#x2665;</tt>"));
+ });
+ return $(returning);
+ }
+ });
+
+ function relative_time(time_value) {
+ var parsed_date = Date.parse(time_value);
+ var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
+ var delta = parseInt((relative_to.getTime() - parsed_date) / 1000);
+ var pluralize = function (singular, n) {
+ return '' + n + ' ' + singular + (n == 1 ? '' : 's');
+ };
+ if(delta < 60) {
+ return 'less than a minute ago';
+ } else if(delta < (45*60)) {
+ return 'about ' + pluralize("minute", parseInt(delta / 60)) + ' ago';
+ } else if(delta < (24*60*60)) {
+ return 'about ' + pluralize("hour", parseInt(delta / 3600)) + ' ago';
+ } else {
+ return 'about ' + pluralize("day", parseInt(delta / 86400)) + ' ago';
+ }
+ }
+
+ function build_url() {
+ var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
+ if (s.list) {
+ return proto+"//api.twitter.com/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?per_page="+s.count+"&callback=?";
+ } else if (s.query == null && s.username.length == 1) {
+ return proto+'//twitter.com/status/user_timeline/'+s.username[0]+'.json?count='+s.count+'&callback=?';
+ } else {
+ var query = (s.query || 'from:'+s.username.join('%20OR%20from:'));
+ return proto+'//search.twitter.com/search.json?&q='+query+'&rpp='+s.count+'&callback=?';
+ }
+ }
+
+ return this.each(function(){
+ var list = $('<ul class="tweet_list">').appendTo(this);
+ var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
+ var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
+ var loading = $('<p class="loading">'+s.loading_text+'</p>');
+
+ if(typeof(s.username) == "string"){
+ s.username = [s.username];
+ }
+
+ if (s.loading_text) $(this).append(loading);
+ $.getJSON(build_url(), function(data){
+ if (s.loading_text) loading.remove();
+ if (s.intro_text) list.before(intro);
+ $.each((data.results || data), function(i,item){
+ // auto join text based on verb tense and content
+ if (s.join_text == "auto") {
+ if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
+ var join_text = s.auto_join_text_reply;
+ } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) {
+ var join_text = s.auto_join_text_url;
+ } else if (item.text.match(/^((\w+ed)|just) .*/im)) {
+ var join_text = s.auto_join_text_ed;
+ } else if (item.text.match(/^(\w*ing) .*/i)) {
+ var join_text = s.auto_join_text_ing;
+ } else {
+ var join_text = s.auto_join_text_default;
+ }
+ } else {
+ var join_text = s.join_text;
+ };
+
+ var from_user = item.from_user || item.user.screen_name;
+ var profile_image_url = item.profile_image_url || item.user.profile_image_url;
+ var join_template = '<span class="tweet_join"> '+join_text+' </span>';
+ var join = ((s.join_text) ? join_template : ' ');
+ var avatar_template = '<a class="tweet_avatar" href="http://twitter.com/'+from_user+'"><img src="'+profile_image_url+'" height="'+s.avatar_size+'" width="'+s.avatar_size+'" alt="'+from_user+'\'s avatar" title="'+from_user+'\'s avatar" border="0"/></a>';
+ var avatar = (s.avatar_size ? avatar_template : '');
+ var date = '<a href="http://twitter.com/'+from_user+'/statuses/'+item.id+'" title="view tweet on twitter">'+relative_time(item.created_at)+'</a>';
+ var text = '<span class="tweet_text">' +$([item.text]).linkUrl().linkUser().linkHash().makeHeart().capAwesome().capEpic()[0]+ '</span>';
+
+ // until we create a template option, arrange the items below to alter a tweet's display.
+ list.append('<li>' + avatar + date + join + text + '</li>');
+
+ list.children('li:first').addClass('tweet_first');
+ list.children('li:odd').addClass('tweet_even');
+ list.children('li:even').addClass('tweet_odd');
+ });
+ if (s.outro_text) list.after(outro);
+ });
+
+ });
+ };
+})(jQuery); \ No newline at end of file
diff --git a/openstack/paste/templates/openstack/doc/source/_static/tweaks.css b/openstack/paste/templates/openstack/doc/source/_static/tweaks.css
new file mode 100644
index 0000000..16cd6e7
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_static/tweaks.css
@@ -0,0 +1,65 @@
+ul.todo_list {
+ list-style-type: none;
+ margin: 0;
+ padding: 0;
+}
+
+ul.todo_list li {
+ display: block;
+ margin: 0;
+ padding: 7px 0;
+ border-top: 1px solid #eee;
+}
+
+ul.todo_list li p {
+ display: inline;
+}
+
+ul.todo_list li p.link {
+ font-weight: bold;
+}
+
+ul.todo_list li p.details {
+ font-style: italic;
+}
+
+ul.todo_list li {
+}
+
+div.admonition {
+ border: 1px solid #8F1000;
+}
+
+div.admonition p.admonition-title {
+ background-color: #8F1000;
+ border-bottom: 1px solid #8E8E8E;
+}
+
+a {
+ color: #CF2F19;
+}
+
+div.related ul li a {
+ color: #CF2F19;
+}
+
+div.sphinxsidebar h4 {
+ background-color:#8E8E8E;
+ border:1px solid #255E6E;
+ color:white;
+ font-size:1em;
+ margin:1em 0 0.5em;
+ padding:0.1em 0 0.1em 0.5em;
+}
+
+em {
+ font-style: normal;
+}
+
+table.docutils {
+ font-size: 11px;
+}
+
+a tt {
+ color:#CF2F19;
+} \ No newline at end of file
diff --git a/openstack/paste/templates/openstack/doc/source/_templates/.placeholder b/openstack/paste/templates/openstack/doc/source/_templates/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_templates/.placeholder
diff --git a/openstack/paste/templates/openstack/doc/source/_theme/layout.html b/openstack/paste/templates/openstack/doc/source/_theme/layout.html
new file mode 100644
index 0000000..e3eb54b
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_theme/layout.html
@@ -0,0 +1,86 @@
+{% extends "sphinxdoc/layout.html" %}
+{% set css_files = css_files + ['_static/tweaks.css'] %}
+{% set script_files = script_files + ['_static/jquery.tweet.js'] %}
+{% block extrahead %}
+ <script type='text/javascript'>
+ $(document).ready(function(){
+ $("#twitter_feed").tweet({
+ username: "openstack",
+ query: "from:openstack",
+ avatar_size: 32,
+ count: 10,
+ loading_text: "loading tweets..."
+ });
+ });
+ </script>
+{% endblock %}
+
+{%- macro sidebar() %}
+ {%- if not embedded %}{% if not theme_nosidebar|tobool %}
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ {%- block sidebarlogo %}
+ {%- if logo %}
+ <p class="logo"><a href="{{ pathto(master_doc) }}">
+ <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ </a></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebartoc %}
+ {%- if display_toc %}
+ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+ {{ toc }}
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebarrel %}
+ {%- if prev %}
+ <h4>{{ _('Previous topic') }}</h4>
+ <p class="topless"><a href="{{ prev.link|e }}"
+ title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
+ {%- endif %}
+ {%- if next %}
+ <h4>{{ _('Next topic') }}</h4>
+ <p class="topless"><a href="{{ next.link|e }}"
+ title="{{ _('next chapter') }}">{{ next.title }}</a></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebarsourcelink %}
+ {%- if show_source and has_source and sourcename %}
+ <h3>{{ _('This Page') }}</h3>
+ <ul class="this-page-menu">
+ <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
+ rel="nofollow">{{ _('Show Source') }}</a></li>
+ </ul>
+ {%- endif %}
+ {%- endblock %}
+ {%- if customsidebar %}
+ {% include customsidebar %}
+ {%- endif %}
+ {%- block sidebarsearch %}
+ {%- if pagename != "search" %}
+ <div id="searchbox" style="display: none">
+ <h3>{{ _('Quick search') }}</h3>
+ <form class="search" action="{{ pathto('search') }}" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="{{ _('Go') }}" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ {{ _('Enter search terms or a module, class or function name.') }}
+ </p>
+ </div>
+ <script type="text/javascript">$('#searchbox').show(0);</script>
+ {%- endif %}
+
+ {%- if pagename == "index" %}
+ <h3>{{ _('Twitter Feed') }}</h3>
+ <div id="twitter_feed" class='twitter_feed'></div>
+ {%- endif %}
+
+
+ {%- endblock %}
+ </div>
+ </div>
+ {%- endif %}{% endif %}
+{%- endmacro %}
diff --git a/openstack/paste/templates/openstack/doc/source/_theme/theme.conf b/openstack/paste/templates/openstack/doc/source/_theme/theme.conf
new file mode 100644
index 0000000..e039fe0
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/_theme/theme.conf
@@ -0,0 +1,5 @@
+[theme]
+inherit = sphinxdoc
+stylesheet = sphinxdoc.css
+pygments_style = friendly
+
diff --git a/openstack/paste/templates/openstack/doc/source/conf.py b/openstack/paste/templates/openstack/doc/source/conf.py
new file mode 100644
index 0000000..cca6b7f
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/conf.py
@@ -0,0 +1,252 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2011 OpenStack, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# Skeleton documentation build configuration file, created by
+# sphinx-quickstart on Tue May 18 13:50:15 2010.
+#
+# This file is execfile()'d with the current directory set to it's 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 os
+import sys
+
+# 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.append([os.path.abspath('../skeleton'),
+ os.path.abspath('..'),
+ os.path.abspath('../bin')
+ ])
+
+# -- General configuration ---------------------------------------------------
+
+# 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.coverage',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.pngmath',
+ 'sphinx.ext.graphviz',
+ 'sphinx.ext.todo']
+
+todo_include_todos = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+if os.getenv('HUDSON_PUBLISH_DOCS'):
+ templates_path = ['_ga', '_templates']
+else:
+ templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Skeleton'
+copyright = u'2011-present, OpenStack, LLC.'
+
+# 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.
+from skeleton import version as skeleton_version
+# The full version, including alpha/beta/rc tags.
+release = skeleton_version.version_string()
+# The short X.Y version.
+version = skeleton_version.canonical_version_string()
+
+# 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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (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 = True
+
+# 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 = ['skeleton.']
+
+# -- Options for man page output --------------------------------------------
+
+# Grouping the document tree for man pages.
+# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
+
+man_pages = [
+ ('man/skeletonapi', 'skeleton-api', u'Skeleton API Server',
+ [u'OpenStack'], 1),
+ ('man/skeletonregistry', 'skeleton-registry', u'Skeleton Registry Server',
+ [u'OpenStack'], 1),
+ ('man/skeletonmanage', 'skeleton-manage', u'Skeleton Management Utility',
+ [u'OpenStack'], 1)
+ ]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme_path = ["."]
+html_theme = '_theme'
+
+# 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 = ['_theme']
+
+# 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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'skeletondoc'
+
+
+# -- 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', 'Skeleton.tex', u'Skeleton Documentation',
+ u'Skeleton Team', '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
+
+# 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_use_modindex = True
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'python': ('http://docs.python.org/', None),
+ 'dashboard': ('http://dashboard.openstack.org', None),
+ 'glance': ('http://glance.openstack.org', None),
+ 'keystone': ('http://keystone.openstack.org', None),
+ 'nova': ('http://nova.openstack.org', None),
+ 'swift': ('http://swift.openstack.org', None)}
diff --git a/openstack/paste/templates/openstack/doc/source/index.rst b/openstack/paste/templates/openstack/doc/source/index.rst
new file mode 100644
index 0000000..a103a89
--- /dev/null
+++ b/openstack/paste/templates/openstack/doc/source/index.rst
@@ -0,0 +1,53 @@
+..
+ Copyright 2011 OpenStack, LLC.
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Welcome to Skeleton's documentation!
+===================================
+
+Description of Skeleton project
+
+Concepts
+========
+
+.. toctree::
+ :maxdepth: 1
+
+Using Skeleton
+==============
+
+.. toctree::
+ :maxdepth: 1
+
+ gettingstarted
+ installing
+
+Developer Docs
+==============
+
+.. toctree::
+ :maxdepth: 1
+
+Outstanding Documentation Tasks
+===============================
+
+.. todolist::
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/openstack/paste/templates/openstack/etc/skeleton-api.conf b/openstack/paste/templates/openstack/etc/skeleton-api.conf
new file mode 100644
index 0000000..2035721
--- /dev/null
+++ b/openstack/paste/templates/openstack/etc/skeleton-api.conf
@@ -0,0 +1,37 @@
+[DEFAULT]
+# Show more verbose log output (sets INFO log level output)
+verbose = True
+
+# Show debugging output in logs (sets DEBUG log level output)
+debug = False
+
+# Address to bind the server to
+bind_host = 0.0.0.0
+
+# Port the bind the server to
+bind_port = 80
+
+# Log to this file. Make sure the user running skeleton-api has
+# permissions to write to this file!
+log_file = /var/log/skeleton/api.log
+
+# Send logs to syslog (/dev/log) instead of to file specified by `log_file`
+use_syslog = False
+
+[pipeline:skeleton-api]
+pipeline = versionnegotiation context apiv1app
+
+[pipeline:versions]
+pipeline = versionsapp
+
+[app:versionsapp]
+paste.app_factory = skeleton.api.versions:app_factory
+
+[app:apiv1app]
+paste.app_factory = skeleton.api.v1:app_factory
+
+[filter:versionnegotiation]
+paste.filter_factory = skeleton.api.middleware.version_negotiation:filter_factory
+
+[filter:context]
+paste.filter_factory = openstack.common.middleware.context:filter_factory
diff --git a/openstack/paste/templates/openstack/openstack/__init__.py b/openstack/paste/templates/openstack/openstack/__init__.py
new file mode 100644
index 0000000..d65c689
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/__init__.py
@@ -0,0 +1,16 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
diff --git a/openstack/paste/templates/openstack/openstack/common/__init__.py b/openstack/paste/templates/openstack/openstack/common/__init__.py
new file mode 100644
index 0000000..b22496f
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/__init__.py
@@ -0,0 +1,19 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# TODO(jaypipes) Code in this module is intended to be ported to the eventual
+# openstack-common library
diff --git a/openstack/paste/templates/openstack/openstack/common/config.py b/openstack/paste/templates/openstack/openstack/common/config.py
new file mode 100644
index 0000000..e954609
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/config.py
@@ -0,0 +1,333 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Routines for configuring Openstack Projects
+"""
+
+import ConfigParser
+import logging
+import logging.config
+import logging.handlers
+import optparse
+import os
+import re
+import sys
+
+from paste import deploy
+
+DEFAULT_LOG_FORMAT = "%(asctime)s %(levelname)8s [%(name)s] %(message)s"
+DEFAULT_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
+
+
+def parse_options(parser, cli_args=None):
+ """
+ Returns the parsed CLI options, command to run and its arguments, merged
+ with any same-named options found in a configuration file.
+
+ The function returns a tuple of (options, args), where options is a
+ mapping of option key/str(value) pairs, and args is the set of arguments
+ (not options) supplied on the command-line.
+
+ The reason that the option values are returned as strings only is that
+ ConfigParser and paste.deploy only accept string values...
+
+ :param parser: The option parser
+ :param cli_args: (Optional) Set of arguments to process. If not present,
+ sys.argv[1:] is used.
+ :retval tuple of (options, args)
+ """
+
+ (options, args) = parser.parse_args(cli_args)
+
+ return (vars(options), args)
+
+
+def add_common_options(parser):
+ """
+ Given a supplied optparse.OptionParser, adds an OptionGroup that
+ represents all common configuration options.
+
+ :param parser: optparse.OptionParser
+ """
+ help_text = "The following configuration options are common to "\
+ "this app's programs."
+
+ group = optparse.OptionGroup(parser, "Common Options", help_text)
+ group.add_option('-v', '--verbose', default=False, dest="verbose",
+ action="store_true",
+ help="Print more verbose output")
+ group.add_option('-d', '--debug', default=False, dest="debug",
+ action="store_true",
+ help="Print debugging output")
+ group.add_option('--config-file', default=None, metavar="PATH",
+ help="Path to the config file to use. When not specified "
+ "(the default), we generally look at the first "
+ "argument specified to be a config file, and if "
+ "that is also missing, we search standard "
+ "directories for a config file.")
+ parser.add_option_group(group)
+
+
+def add_log_options(parser):
+ """
+ Given a supplied optparse.OptionParser, adds an OptionGroup that
+ represents all the configuration options around logging.
+
+ :param parser: optparse.OptionParser
+ """
+ help_text = "The following configuration options are specific to logging "\
+ "functionality for this program."
+
+ group = optparse.OptionGroup(parser, "Logging Options", help_text)
+ group.add_option('--log-config', default=None, metavar="PATH",
+ help="If this option is specified, the logging "
+ "configuration file specified is used and overrides "
+ "any other logging options specified. Please see "
+ "the Python logging module documentation for "
+ "details on logging configuration files.")
+ group.add_option('--log-date-format', metavar="FORMAT",
+ default=DEFAULT_LOG_DATE_FORMAT,
+ help="Format string for %(asctime)s in log records. "
+ "Default: %default")
+ group.add_option('--log-file', default=None, metavar="PATH",
+ help="(Optional) Name of log file to output to. "
+ "If not set, logging will go to stdout.")
+ group.add_option("--log-dir", default=None,
+ help="(Optional) The directory to keep log files in "
+ "(will be prepended to --logfile)")
+ group.add_option('--use-syslog', default=False, dest="use_syslog",
+ action="store_true",
+ help="Use syslog for logging.")
+ parser.add_option_group(group)
+
+
+def setup_logging(options, conf):
+ """
+ Sets up the logging options for a log with supplied name
+
+ :param options: Mapping of typed option key/values
+ :param conf: Mapping of untyped key/values from config file
+ """
+
+ if options.get('log_config', None):
+ # Use a logging configuration file for all settings...
+ if os.path.exists(options['log_config']):
+ logging.config.fileConfig(options['log_config'])
+ return
+ else:
+ raise RuntimeError("Unable to locate specified logging "
+ "config file: %s" % options['log_config'])
+
+ # If either the CLI option or the conf value
+ # is True, we set to True
+ debug = options.get('debug') or \
+ get_option(conf, 'debug', type='bool', default=False)
+ verbose = options.get('verbose') or \
+ get_option(conf, 'verbose', type='bool', default=False)
+ root_logger = logging.root
+ if debug:
+ root_logger.setLevel(logging.DEBUG)
+ elif verbose:
+ root_logger.setLevel(logging.INFO)
+ else:
+ root_logger.setLevel(logging.WARNING)
+
+ # Set log configuration from options...
+ # Note that we use a hard-coded log format in the options
+ # because of Paste.Deploy bug #379
+ # http://trac.pythonpaste.org/pythonpaste/ticket/379
+ log_format = options.get('log_format', DEFAULT_LOG_FORMAT)
+ log_date_format = options.get('log_date_format', DEFAULT_LOG_DATE_FORMAT)
+ formatter = logging.Formatter(log_format, log_date_format)
+
+ logfile = options.get('log_file')
+ if not logfile:
+ logfile = conf.get('log_file')
+
+ use_syslog = options.get('use_syslog') or \
+ get_option(conf, 'use_syslog', type='bool', default=False)
+
+ if use_syslog:
+ handler = logging.handlers.SysLogHandler(address='/dev/log')
+ elif logfile:
+ logdir = options.get('log_dir')
+ if not logdir:
+ logdir = conf.get('log_dir')
+ if logdir:
+ logfile = os.path.join(logdir, logfile)
+ handler = logging.FileHandler(logfile)
+ else:
+ handler = logging.StreamHandler(sys.stdout)
+
+ handler.setFormatter(formatter)
+ root_logger.addHandler(handler)
+
+
+def find_config_file(app_name, options, args, config_dir=None):
+ """
+ Return the first config file found for an application.
+
+ We search for the paste config file in the following order:
+ * If --config-file option is used, use that
+ * If args[0] is a file, use that
+ * Search for $app.conf in standard directories:
+ * .
+ * ~.config_dir/
+ * ~
+ * /etc/config_dir
+ * /etc
+
+ :retval Full path to config file, or None if no config file found
+ """
+ config_dir = config_dir or app_name
+
+ fix_path = lambda p: os.path.abspath(os.path.expanduser(p))
+ if options.get('config_file'):
+ if os.path.exists(options['config_file']):
+ return fix_path(options['config_file'])
+ elif args:
+ if os.path.exists(args[0]):
+ return fix_path(args[0])
+
+ # Handle standard directory search for $app_name.conf
+ config_file_dirs = [fix_path(os.getcwd()),
+ fix_path(os.path.join('~', '.' + config_dir)),
+ fix_path('~'),
+ os.path.join('/etc', config_dir),
+ '/etc']
+
+ for cfg_dir in config_file_dirs:
+ cfg_file = os.path.join(cfg_dir, '%s.conf' % app_name)
+ if os.path.exists(cfg_file):
+ return cfg_file
+
+
+def load_paste_config(app_name, options, args, config_dir=None):
+ """
+ Looks for a config file to use for an app and returns the
+ config file path and a configuration mapping from a paste config file.
+
+ We search for the paste config file in the following order:
+ * If --config-file option is used, use that
+ * If args[0] is a file, use that
+ * Search for $app_name.conf in standard directories:
+ * .
+ * ~.config_dir/
+ * ~
+ * /etc/config_dir
+ * /etc
+
+ :param app_name: Name of the application to load config for, or None.
+ None signifies to only load the [DEFAULT] section of
+ the config file.
+ :param options: Set of typed options returned from parse_options()
+ :param args: Command line arguments from argv[1:]
+ :retval Tuple of (conf_file, conf)
+
+ :raises RuntimeError when config file cannot be located or there was a
+ problem loading the configuration file.
+ """
+ conf_file = find_config_file(app_name, options, args, config_dir)
+ if not conf_file:
+ raise RuntimeError("Unable to locate any configuration file. "
+ "Cannot load application %s" % app_name)
+ try:
+ conf = deploy.appconfig("config:%s" % conf_file, name=app_name)
+ return conf_file, conf
+ except Exception, e:
+ raise RuntimeError("Error trying to load config %s: %s"
+ % (conf_file, e))
+
+
+def load_paste_app(app_name, options, args, config_dir=None):
+ """
+ Builds and returns a WSGI app from a paste config file.
+
+ We search for the paste config file in the following order:
+ * If --config-file option is used, use that
+ * If args[0] is a file, use that
+ * Search for $app_name.conf in standard directories:
+ * .
+ * ~.config_dir/
+ * ~
+ * /etc/config_dir
+ * /etc
+
+ :param app_name: Name of the application to load
+ :param options: Set of typed options returned from parse_options()
+ :param args: Command line arguments from argv[1:]
+
+ :raises RuntimeError when config file cannot be located or application
+ cannot be loaded from config file
+ """
+ conf_file, conf = load_paste_config(app_name, options,
+ args, config_dir)
+
+ try:
+ # Setup logging early, supplying both the CLI options and the
+ # configuration mapping from the config file
+ setup_logging(options, conf)
+
+ # We only update the conf dict for the verbose and debug
+ # flags. Everything else must be set up in the conf file...
+ debug = options.get('debug') or \
+ get_option(conf, 'debug', type='bool', default=False)
+ verbose = options.get('verbose') or \
+ get_option(conf, 'verbose', type='bool', default=False)
+ conf['debug'] = debug
+ conf['verbose'] = verbose
+
+ # Log the options used when starting if we're in debug mode...
+ if debug:
+ logger = logging.getLogger(app_name)
+ logger.debug("*" * 80)
+ logger.debug("Configuration options gathered from config file:")
+ logger.debug(conf_file)
+ logger.debug("================================================")
+ items = dict([(k, v) for k, v in conf.items()
+ if k not in ('__file__', 'here')])
+ for key, value in sorted(items.items()):
+ logger.debug("%(key)-30s %(value)s" % locals())
+ logger.debug("*" * 80)
+ app = deploy.loadapp("config:%s" % conf_file, name=app_name)
+ except (LookupError, ImportError), e:
+ raise RuntimeError("Unable to load %(app_name)s from "
+ "configuration file %(conf_file)s."
+ "\nGot: %(e)r" % locals())
+ return conf, app
+
+
+def get_option(options, option, **kwargs):
+ if option in options:
+ value = options[option]
+ type_ = kwargs.get('type', 'str')
+ if type_ == 'bool':
+ if hasattr(value, 'lower'):
+ return value.lower() == 'true'
+ else:
+ return value
+ elif type_ == 'int':
+ return int(value)
+ elif type_ == 'float':
+ return float(value)
+ else:
+ return value
+ elif 'default' in kwargs:
+ return kwargs['default']
+ else:
+ raise KeyError("option '%s' not found" % option)
diff --git a/openstack/paste/templates/openstack/openstack/common/context.py b/openstack/paste/templates/openstack/openstack/common/context.py
new file mode 100644
index 0000000..a9a16f8
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/context.py
@@ -0,0 +1,40 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Simple class that stores security context information in the web request.
+
+Projects should subclass this class if they wish to enhance the request
+context or provide additional information in their specific WSGI pipeline.
+"""
+
+
+class RequestContext(object):
+
+ """
+ Stores information about the security context under which the user
+ accesses the system, as well as additional request information.
+ """
+
+ def __init__(self, auth_tok=None, user=None, tenant=None, is_admin=False,
+ read_only=False, show_deleted=False):
+ self.auth_tok = auth_tok
+ self.user = user
+ self.tenant = tenant
+ self.is_admin = is_admin
+ self.read_only = read_only
+ self.show_deleted = show_deleted
diff --git a/openstack/paste/templates/openstack/openstack/common/exception.py b/openstack/paste/templates/openstack/openstack/common/exception.py
new file mode 100644
index 0000000..a81355e
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/exception.py
@@ -0,0 +1,143 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Exceptions common to OpenStack projects
+"""
+
+import logging
+
+
+class ProcessExecutionError(IOError):
+ def __init__(self, stdout=None, stderr=None, exit_code=None, cmd=None,
+ description=None):
+ if description is None:
+ description = "Unexpected error while running command."
+ if exit_code is None:
+ exit_code = '-'
+ message = "%s\nCommand: %s\nExit code: %s\nStdout: %r\nStderr: %r" % (
+ description, cmd, exit_code, stdout, stderr)
+ IOError.__init__(self, message)
+
+
+class Error(Exception):
+ def __init__(self, message=None):
+ super(Error, self).__init__(message)
+
+
+class ApiError(Error):
+ def __init__(self, message='Unknown', code='Unknown'):
+ self.message = message
+ self.code = code
+ super(ApiError, self).__init__('%s: %s' % (code, message))
+
+
+class NotFound(Error):
+ pass
+
+
+class UnknownScheme(Error):
+
+ msg = "Unknown scheme '%s' found in URI"
+
+ def __init__(self, scheme):
+ msg = self.__class__.msg % scheme
+ super(UnknownScheme, self).__init__(msg)
+
+
+class BadStoreUri(Error):
+
+ msg = "The Store URI %s was malformed. Reason: %s"
+
+ def __init__(self, uri, reason):
+ msg = self.__class__.msg % (uri, reason)
+ super(BadStoreUri, self).__init__(msg)
+
+
+class Duplicate(Error):
+ pass
+
+
+class NotAuthorized(Error):
+ pass
+
+
+class NotEmpty(Error):
+ pass
+
+
+class Invalid(Error):
+ pass
+
+
+class BadInputError(Exception):
+ """Error resulting from a client sending bad input to a server"""
+ pass
+
+
+class MissingArgumentError(Error):
+ pass
+
+
+class DatabaseMigrationError(Error):
+ pass
+
+
+class ClientConnectionError(Exception):
+ """Error resulting from a client connecting to a server"""
+ pass
+
+
+def wrap_exception(f):
+ def _wrap(*args, **kw):
+ try:
+ return f(*args, **kw)
+ except Exception, e:
+ if not isinstance(e, Error):
+ #exc_type, exc_value, exc_traceback = sys.exc_info()
+ logging.exception('Uncaught exception')
+ #logging.error(traceback.extract_stack(exc_traceback))
+ raise Error(str(e))
+ raise
+ _wrap.func_name = f.func_name
+ return _wrap
+
+
+class OpenstackException(Exception):
+ """
+ Base Exception
+
+ To correctly use this class, inherit from it and define
+ a 'message' property. That message will get printf'd
+ with the keyword arguments provided to the constructor.
+ """
+ message = "An unknown exception occurred"
+
+ def __init__(self, **kwargs):
+ try:
+ self._error_string = self.message % kwargs
+
+ except Exception:
+ # at least get the core message out if something happened
+ self._error_string = self.message
+
+ def __str__(self):
+ return self._error_string
+
+
+class InvalidContentType(OpenstackException):
+ message = "Invalid content type %(content_type)s"
diff --git a/openstack/paste/templates/openstack/openstack/common/middleware/__init__.py b/openstack/paste/templates/openstack/openstack/common/middleware/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/middleware/__init__.py
diff --git a/openstack/paste/templates/openstack/openstack/common/middleware/context.py b/openstack/paste/templates/openstack/openstack/common/middleware/context.py
new file mode 100644
index 0000000..be7dafe
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/middleware/context.py
@@ -0,0 +1,64 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Middleware that attaches a context to the WSGI request
+"""
+
+from openstack.common import utils
+from openstack.common import wsgi
+from openstack.common import context
+
+
+class ContextMiddleware(wsgi.Middleware):
+ def __init__(self, app, options):
+ self.options = options
+ super(ContextMiddleware, self).__init__(app)
+
+ def make_context(self, *args, **kwargs):
+ """
+ Create a context with the given arguments.
+ """
+
+ # Determine the context class to use
+ ctxcls = context.RequestContext
+ if 'context_class' in self.options:
+ ctxcls = utils.import_class(self.options['context_class'])
+
+ return ctxcls(*args, **kwargs)
+
+ def process_request(self, req):
+ """
+ Extract any authentication information in the request and
+ construct an appropriate context from it.
+ """
+ # Use the default empty context, with admin turned on for
+ # backwards compatibility
+ req.context = self.make_context(is_admin=True)
+
+
+def filter_factory(global_conf, **local_conf):
+ """
+ Factory method for paste.deploy
+ """
+ conf = global_conf.copy()
+ conf.update(local_conf)
+
+ def filter(app):
+ return ContextMiddleware(app, conf)
+
+ return filter
diff --git a/openstack/paste/templates/openstack/openstack/common/utils.py b/openstack/paste/templates/openstack/openstack/common/utils.py
new file mode 100644
index 0000000..0d2f89e
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/utils.py
@@ -0,0 +1,89 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+System-level utilities and helper functions.
+"""
+
+import datetime
+import sys
+
+from openstack.common import exception
+
+
+TIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+
+def int_from_bool_as_string(subject):
+ """
+ Interpret a string as a boolean and return either 1 or 0.
+
+ Any string value in:
+ ('True', 'true', 'On', 'on', '1')
+ is interpreted as a boolean True.
+
+ Useful for JSON-decoded stuff and config file parsing
+ """
+ return bool_from_string(subject) and 1 or 0
+
+
+def bool_from_string(subject):
+ """
+ Interpret a string as a boolean.
+
+ Any string value in:
+ ('True', 'true', 'On', 'on', '1')
+ is interpreted as a boolean True.
+
+ Useful for JSON-decoded stuff and config file parsing
+ """
+ if type(subject) == type(bool):
+ return subject
+ if hasattr(subject, 'startswith'): # str or unicode...
+ if subject.strip().lower() in ('true', 'on', '1'):
+ return True
+ return False
+
+
+def import_class(import_str):
+ """Returns a class from a string including module and class"""
+ mod_str, _sep, class_str = import_str.rpartition('.')
+ try:
+ __import__(mod_str)
+ return getattr(sys.modules[mod_str], class_str)
+ except (ImportError, ValueError, AttributeError):
+ raise exception.NotFound('Class %s cannot be found' % class_str)
+
+
+def import_object(import_str):
+ """Returns an object including a module or module and class"""
+ try:
+ __import__(import_str)
+ return sys.modules[import_str]
+ except ImportError:
+ cls = import_class(import_str)
+ return cls()
+
+
+def isotime(at=None):
+ if not at:
+ at = datetime.datetime.utcnow()
+ return at.strftime(TIME_FORMAT)
+
+
+def parse_isotime(timestr):
+ return datetime.datetime.strptime(timestr, TIME_FORMAT)
diff --git a/openstack/paste/templates/openstack/openstack/common/wsgi.py b/openstack/paste/templates/openstack/openstack/common/wsgi.py
new file mode 100644
index 0000000..8faa6dc
--- /dev/null
+++ b/openstack/paste/templates/openstack/openstack/common/wsgi.py
@@ -0,0 +1,353 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""
+Utility methods for working with WSGI servers
+"""
+
+import json
+import logging
+import sys
+import datetime
+
+import eventlet
+import eventlet.wsgi
+eventlet.patcher.monkey_patch(all=False, socket=True)
+import routes
+import routes.middleware
+import webob.dec
+import webob.exc
+
+from openstack.common import exception
+
+
+class WritableLogger(object):
+ """A thin wrapper that responds to `write` and logs."""
+
+ def __init__(self, logger, level=logging.DEBUG):
+ self.logger = logger
+ self.level = level
+
+ def write(self, msg):
+ self.logger.log(self.level, msg.strip("\n"))
+
+
+def run_server(application, port):
+ """Run a WSGI server with the given application."""
+ sock = eventlet.listen(('0.0.0.0', port))
+ eventlet.wsgi.server(sock, application)
+
+
+class Server(object):
+ """Server class to manage multiple WSGI sockets and applications."""
+
+ def __init__(self, threads=1000):
+ self.pool = eventlet.GreenPool(threads)
+
+ def start(self, application, port, host='0.0.0.0', backlog=128):
+ """Run a WSGI server with the given application."""
+ socket = eventlet.listen((host, port), backlog=backlog)
+ self.pool.spawn_n(self._run, application, socket)
+
+ def wait(self):
+ """Wait until all servers have completed running."""
+ try:
+ self.pool.waitall()
+ except KeyboardInterrupt:
+ pass
+
+ def _run(self, application, socket):
+ """Start a WSGI server in a new green thread."""
+ logger = logging.getLogger('eventlet.wsgi.server')
+ eventlet.wsgi.server(socket, application, custom_pool=self.pool,
+ log=WritableLogger(logger))
+
+
+class Middleware(object):
+ """
+ Base WSGI middleware wrapper. These classes require an application to be
+ initialized that will be called next. By default the middleware will
+ simply call its wrapped app, or you can override __call__ to customize its
+ behavior.
+ """
+
+ def __init__(self, application):
+ self.application = application
+
+ def process_request(self, req):
+ """
+ Called on each request.
+
+ If this returns None, the next application down the stack will be
+ executed. If it returns a response then that response will be returned
+ and execution will stop here.
+ """
+ return None
+
+ def process_response(self, response):
+ """Do whatever you'd like to the response."""
+ return response
+
+ @webob.dec.wsgify
+ def __call__(self, req):
+ response = self.process_request(req)
+ if response:
+ return response
+ response = req.get_response(self.application)
+ return self.process_response(response)
+
+
+class Debug(Middleware):
+ """
+ Helper class that can be inserted into any WSGI application chain
+ to get information about the request and response.
+ """
+
+ @webob.dec.wsgify
+ def __call__(self, req):
+ print ("*" * 40) + " REQUEST ENVIRON"
+ for key, value in req.environ.items():
+ print key, "=", value
+ print
+ resp = req.get_response(self.application)
+
+ print ("*" * 40) + " RESPONSE HEADERS"
+ for (key, value) in resp.headers.iteritems():
+ print key, "=", value
+ print
+
+ resp.app_iter = self.print_generator(resp.app_iter)
+
+ return resp
+
+ @staticmethod
+ def print_generator(app_iter):
+ """
+ Iterator that prints the contents of a wrapper string iterator
+ when iterated.
+ """
+ print ("*" * 40) + " BODY"
+ for part in app_iter:
+ sys.stdout.write(part)
+ sys.stdout.flush()
+ yield part
+ print
+
+
+class Router(object):
+
+ """
+ WSGI middleware that maps incoming requests to WSGI apps.
+ """
+
+ def __init__(self, mapper):
+ """
+ Create a router for the given routes.Mapper.
+
+ Each route in `mapper` must specify a 'controller', which is a
+ WSGI app to call. You'll probably want to specify an 'action' as
+ well and have your controller be a wsgi.Controller, who will route
+ the request to the action method.
+
+ Examples:
+ mapper = routes.Mapper()
+ sc = ServerController()
+
+ # Explicit mapping of one route to a controller+action
+ mapper.connect(None, "/svrlist", controller=sc, action="list")
+
+ # Actions are all implicitly defined
+ mapper.resource("server", "servers", controller=sc)
+
+ # Pointing to an arbitrary WSGI app. You can specify the
+ # {path_info:.*} parameter so the target app can be handed just that
+ # section of the URL.
+ mapper.connect(None, "/v1.0/{path_info:.*}", controller=BlogApp())
+ """
+ self.map = mapper
+ self._router = routes.middleware.RoutesMiddleware(self._dispatch,
+ self.map)
+
+ @webob.dec.wsgify
+ def __call__(self, req):
+ """
+ Route the incoming request to a controller based on self.map.
+ If no match, return a 404.
+ """
+ return self._router
+
+ @staticmethod
+ @webob.dec.wsgify
+ def _dispatch(req):
+ """
+ Called by self._router after matching the incoming request to a route
+ and putting the information into req.environ. Either returns 404
+ or the routed WSGI app's response.
+ """
+ match = req.environ['wsgiorg.routing_args'][1]
+ if not match:
+ return webob.exc.HTTPNotFound()
+ app = match['controller']
+ return app
+
+
+class Request(webob.Request):
+
+ """Add some Openstack API-specific logic to the base webob.Request."""
+
+ def best_match_content_type(self):
+ """Determine the requested response content-type."""
+ supported = ('application/json',)
+ bm = self.accept.best_match(supported)
+ return bm or 'application/json'
+
+ def get_content_type(self, allowed_content_types):
+ """Determine content type of the request body."""
+ if not "Content-Type" in self.headers:
+ raise exception.InvalidContentType(content_type=None)
+
+ content_type = self.content_type
+
+ if content_type not in allowed_content_types:
+ raise exception.InvalidContentType(content_type=content_type)
+ else:
+ return content_type
+
+
+class JSONRequestDeserializer(object):
+ def has_body(self, request):
+ """
+ Returns whether a Webob.Request object will possess an entity body.
+
+ :param request: Webob.Request object
+ """
+ if 'transfer-encoding' in request.headers:
+ return True
+ elif request.content_length > 0:
+ return True
+
+ return False
+
+ def from_json(self, datastring):
+ return json.loads(datastring)
+
+ def default(self, request):
+ if self.has_body(request):
+ return {'body': self.from_json(request.body)}
+ else:
+ return {}
+
+
+class JSONResponseSerializer(object):
+
+ def to_json(self, data):
+ def sanitizer(obj):
+ if isinstance(obj, datetime.datetime):
+ return obj.isoformat()
+ return obj
+
+ return json.dumps(data, default=sanitizer)
+
+ def default(self, response, result):
+ response.headers.add('Content-Type', 'application/json')
+ response.body = self.to_json(result)
+
+
+class Resource(object):
+ """
+ WSGI app that handles (de)serialization and controller dispatch.
+
+ Reads routing information supplied by RoutesMiddleware and calls
+ the requested action method upon its deserializer, controller,
+ and serializer. Those three objects may implement any of the basic
+ controller action methods (create, update, show, index, delete)
+ along with any that may be specified in the api router. A 'default'
+ method may also be implemented to be used in place of any
+ non-implemented actions. Deserializer methods must accept a request
+ argument and return a dictionary. Controller methods must accept a
+ request argument. Additionally, they must also accept keyword
+ arguments that represent the keys returned by the Deserializer. They
+ may raise a webob.exc exception or return a dict, which will be
+ serialized by requested content type.
+ """
+ def __init__(self, controller, deserializer, serializer):
+ """
+ :param controller: object that implement methods created by routes lib
+ :param deserializer: object that supports webob request deserialization
+ through controller-like actions
+ :param serializer: object that supports webob response serialization
+ through controller-like actions
+ """
+ self.controller = controller
+ self.serializer = serializer
+ self.deserializer = deserializer
+
+ @webob.dec.wsgify(RequestClass=Request)
+ def __call__(self, request):
+ """WSGI method that controls (de)serialization and method dispatch."""
+ action_args = self.get_action_args(request.environ)
+ action = action_args.pop('action', None)
+
+ deserialized_params = self.deserialize_request(action, request)
+ action_args.update(deserialized_params)
+ action_result = self.execute_action(action, request, **action_args)
+ try:
+ return self.serialize_response(action, action_result, request)
+
+ # return unserializable result (typically a webob exc)
+ except Exception:
+ return action_result
+
+ def deserialize_request(self, action, request):
+ return self.dispatch(self.deserializer, action, request)
+
+ def serialize_response(self, action, action_result, request):
+ response = webob.Response()
+ self.dispatch(self.serializer, action, response,
+ action_result, request)
+ return response
+
+ def execute_action(self, action, request, **action_args):
+ return self.dispatch(self.controller, action, request, **action_args)
+
+ def dispatch(self, obj, action, *args, **kwargs):
+ """Find action-specific method on self and call it."""
+ try:
+ method = getattr(obj, action)
+ except AttributeError:
+ method = getattr(obj, 'default')
+
+ return method(*args, **kwargs)
+
+ def get_action_args(self, request_environment):
+ """Parse dictionary created by routes library."""
+ try:
+ args = request_environment['wsgiorg.routing_args'][1].copy()
+ except Exception:
+ return {}
+
+ try:
+ del args['controller']
+ except KeyError:
+ pass
+
+ try:
+ del args['format']
+ except KeyError:
+ pass
+
+ return args
diff --git a/openstack/paste/templates/openstack/setup.cfg b/openstack/paste/templates/openstack/setup.cfg
new file mode 100644
index 0000000..d53addc
--- /dev/null
+++ b/openstack/paste/templates/openstack/setup.cfg
@@ -0,0 +1,9 @@
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+
+[egg_info]
+tag_build =
+tag_date = 0
+tag_svn_revision = 0
diff --git a/openstack/paste/templates/openstack/setup.py b/openstack/paste/templates/openstack/setup.py
new file mode 100644
index 0000000..c6d3c69
--- /dev/null
+++ b/openstack/paste/templates/openstack/setup.py
@@ -0,0 +1,89 @@
+#!/usr/bin/python
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import os
+import subprocess
+
+from setuptools import setup, find_packages
+from setuptools.command.sdist import sdist
+
+from skeleton import version
+
+
+if os.path.isdir('.bzr'):
+ with open("skeleton/vcsversion.py", 'w') as version_file:
+ vcs_cmd = subprocess.Popen(["bzr", "version-info", "--python"],
+ stdout=subprocess.PIPE)
+ vcsversion = vcs_cmd.communicate()[0]
+ version_file.write(vcsversion)
+
+
+class local_sdist(sdist):
+ """Customized sdist hook - builds the ChangeLog file from VC first"""
+
+ def run(self):
+ if os.path.isdir('.bzr'):
+ # We're in a bzr branch
+
+ log_cmd = subprocess.Popen(["bzr", "log", "--gnu"],
+ stdout=subprocess.PIPE)
+ changelog = log_cmd.communicate()[0]
+ with open("ChangeLog", "w") as changelog_file:
+ changelog_file.write(changelog)
+ sdist.run(self)
+
+cmdclass = {'sdist': local_sdist}
+
+# If Sphinx is installed on the box running setup.py,
+# enable setup.py to build the documentation, otherwise,
+# just ignore it
+try:
+ from sphinx.setup_command import BuildDoc
+
+ class local_BuildDoc(BuildDoc):
+ def run(self):
+ for builder in ['html', 'man']:
+ self.builder = builder
+ self.finalize_options()
+ BuildDoc.run(self)
+ cmdclass['build_sphinx'] = local_BuildDoc
+
+except:
+ pass
+
+
+setup(
+ name='skeleton',
+ version=version.canonical_version_string(),
+ description='The Skeleton project provides a simple WSGI server demo',
+ license='Apache License (2.0)',
+ author='OpenStack',
+ author_email='openstack@lists.launchpad.net',
+ url='http://skeleton.openstack.org/',
+ packages=find_packages(exclude=['tests', 'bin']),
+ test_suite='nose.collector',
+ cmdclass=cmdclass,
+ include_package_data=True,
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'License :: OSI Approved :: Apache Software License',
+ 'Operating System :: POSIX :: Linux',
+ 'Programming Language :: Python :: 2.6',
+ 'Environment :: No Input/Output (Daemon)',
+ ],
+ scripts=['bin/skeleton-api'])
diff --git a/openstack/paste/templates/openstack/skeleton/__init__.py b/openstack/paste/templates/openstack/skeleton/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/skeleton/__init__.py
diff --git a/openstack/paste/templates/openstack/skeleton/api/__init__.py b/openstack/paste/templates/openstack/skeleton/api/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/skeleton/api/__init__.py
diff --git a/openstack/paste/templates/openstack/skeleton/api/middleware/__init__.py b/openstack/paste/templates/openstack/skeleton/api/middleware/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/skeleton/api/middleware/__init__.py
diff --git a/openstack/paste/templates/openstack/skeleton/api/v1/__init__.py b/openstack/paste/templates/openstack/skeleton/api/v1/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/skeleton/api/v1/__init__.py
diff --git a/openstack/paste/templates/openstack/skeleton/version.py b/openstack/paste/templates/openstack/skeleton/version.py
new file mode 100644
index 0000000..943c019
--- /dev/null
+++ b/openstack/paste/templates/openstack/skeleton/version.py
@@ -0,0 +1,49 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""Determine version of Skeleton library"""
+
+try:
+ from skeleton.vcsversion import version_info
+except ImportError:
+ version_info = {'branch_nick': u'LOCALBRANCH',
+ 'revision_id': 'LOCALREVISION',
+ 'revno': 0}
+
+SKELETON_VERSION = ['2011', '3']
+YEAR, COUNT = SKELETON_VERSION
+
+FINAL = False # This becomes true at Release Candidate time
+
+
+def canonical_version_string():
+ return '.'.join([YEAR, COUNT])
+
+
+def version_string():
+ if FINAL:
+ return canonical_version_string()
+ else:
+ return '%s-dev' % (canonical_version_string(),)
+
+
+def vcs_version_string():
+ return "%s:%s" % (version_info['branch_nick'], version_info['revision_id'])
+
+
+def version_string_with_vcs():
+ return "%s-%s" % (canonical_version_string(), vcs_version_string())
diff --git a/openstack/paste/templates/openstack/tests/__init__.py b/openstack/paste/templates/openstack/tests/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/tests/__init__.py
diff --git a/openstack/paste/templates/openstack/tests/functional/__init__.py b/openstack/paste/templates/openstack/tests/functional/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/tests/functional/__init__.py
diff --git a/openstack/paste/templates/openstack/tests/unit/__init__.py b/openstack/paste/templates/openstack/tests/unit/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/openstack/paste/templates/openstack/tests/unit/__init__.py