Clean up directory structure, unused files, etc

jeffknupp · Aug 8, 2013 · 44789d2 · 44789d2
1 parent 41386e7
commit 44789d2
Show file tree

Hide file tree

Showing 63 changed files with 104 additions and 39 deletions.
diff --git a/LICENSE b/LICENSE
@@ -176,7 +176,7 @@ recommend that a file or class name and description of purpose be included on
 the same "printed page" as the copyright notice for easier identification within
 third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2013 Jeff Knupp
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.doctrees/quickstart.doctree b/docs/.doctrees/quickstart.doctree
diff --git a/docs/.doctrees/sandman.doctree b/docs/.doctrees/sandman.doctree
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/docs/generated/.buildinfo b/docs/generated/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 
+tags: 
diff --git a/docs/generated/.doctrees/environment.pickle b/docs/generated/.doctrees/environment.pickle
diff --git a/docs/generated/.doctrees/index.doctree b/docs/generated/.doctrees/index.doctree
diff --git a/docs/generated/.doctrees/installation.doctree b/docs/generated/.doctrees/installation.doctree
diff --git a/docs/generated/.doctrees/modules.doctree b/docs/generated/.doctrees/modules.doctree
diff --git a/docs/generated/.doctrees/quickstart.doctree b/docs/generated/.doctrees/quickstart.doctree
diff --git a/docs/generated/.doctrees/sandman.doctree b/docs/generated/.doctrees/sandman.doctree
diff --git a/docs/_modules/index.html → docs/generated/_modules/index.html b/docs/_modules/index.html → docs/generated/_modules/index.html
diff --git a/docs/_modules/sandman/exception.html → ...generated/_modules/sandman/exception.html b/docs/_modules/sandman/exception.html → ...generated/_modules/sandman/exception.html
diff --git a/docs/_modules/sandman/model.html → docs/generated/_modules/sandman/model.html b/docs/_modules/sandman/model.html → docs/generated/_modules/sandman/model.html
@@ -62,7 +62,7 @@ <h1>Source code for sandman.model</h1><div class="highlight"><pre>
 <span class="sd">    endpoint.</span>
 <span class="sd">    </span>
 <span class="sd">    :param cls: User-defined class derived from :class:`sandman.Resource` to be</span>
-<span class="sd">    registered with the endpoint returned by :func:`endpoint()`</span>
+<span class="sd">                registered with the endpoint returned by :func:`endpoint()`</span>
 <span class="sd">    :type cls: :class:`sandman.Resource` or tuple</span>
 <span class="sd">    </span>
 <span class="sd">    &quot;&quot;&quot;</span>

diff --git a/docs/_modules/sandman/sandman.html → docs/generated/_modules/sandman/sandman.html b/docs/_modules/sandman/sandman.html → docs/generated/_modules/sandman/sandman.html
diff --git a/docs/_sources/index.txt → docs/generated/_sources/index.txt b/docs/_sources/index.txt → docs/generated/_sources/index.txt
diff --git a/docs/_sources/installation.txt → docs/generated/_sources/installation.txt b/docs/_sources/installation.txt → docs/generated/_sources/installation.txt
diff --git a/docs/_sources/modules.txt → docs/generated/_sources/modules.txt b/docs/_sources/modules.txt → docs/generated/_sources/modules.txt
diff --git a/docs/_sources/quickstart.txt → docs/generated/_sources/quickstart.txt b/docs/_sources/quickstart.txt → docs/generated/_sources/quickstart.txt
@@ -13,7 +13,6 @@ Create one file with the following contents (which I call ``runserver.py``)::
     from sandman import app, db
     app.config['SQLALCHEMY_DATABASE_URI'] = '<your database connection string (using SQLAlchemy)'
     app.run()
-    ```
 
 Then simply run::
 

diff --git a/docs/_sources/sandman.txt → docs/generated/_sources/sandman.txt b/docs/_sources/sandman.txt → docs/generated/_sources/sandman.txt
diff --git a/docs/_static/ajax-loader.gif → docs/generated/_static/ajax-loader.gif b/docs/_static/ajax-loader.gif → docs/generated/_static/ajax-loader.gif
diff --git a/docs/_static/basic.css → docs/generated/_static/basic.css b/docs/_static/basic.css → docs/generated/_static/basic.css
diff --git a/docs/_static/comment-bright.png → docs/generated/_static/comment-bright.png b/docs/_static/comment-bright.png → docs/generated/_static/comment-bright.png
diff --git a/docs/_static/comment-close.png → docs/generated/_static/comment-close.png b/docs/_static/comment-close.png → docs/generated/_static/comment-close.png
diff --git a/docs/_static/comment.png → docs/generated/_static/comment.png b/docs/_static/comment.png → docs/generated/_static/comment.png
diff --git a/docs/_static/doctools.js → docs/generated/_static/doctools.js b/docs/_static/doctools.js → docs/generated/_static/doctools.js
diff --git a/docs/_static/down-pressed.png → docs/generated/_static/down-pressed.png b/docs/_static/down-pressed.png → docs/generated/_static/down-pressed.png
diff --git a/docs/_static/down.png → docs/generated/_static/down.png b/docs/_static/down.png → docs/generated/_static/down.png
diff --git a/docs/_static/file.png → docs/generated/_static/file.png b/docs/_static/file.png → docs/generated/_static/file.png
diff --git a/docs/_static/jquery.js → docs/generated/_static/jquery.js b/docs/_static/jquery.js → docs/generated/_static/jquery.js
diff --git a/docs/_static/minus.png → docs/generated/_static/minus.png b/docs/_static/minus.png → docs/generated/_static/minus.png
diff --git a/docs/_static/nature.css → docs/generated/_static/nature.css b/docs/_static/nature.css → docs/generated/_static/nature.css
diff --git a/docs/_static/plus.png → docs/generated/_static/plus.png b/docs/_static/plus.png → docs/generated/_static/plus.png
diff --git a/docs/_static/pygments.css → docs/generated/_static/pygments.css b/docs/_static/pygments.css → docs/generated/_static/pygments.css
diff --git a/docs/_static/searchtools.js → docs/generated/_static/searchtools.js b/docs/_static/searchtools.js → docs/generated/_static/searchtools.js
diff --git a/docs/_static/underscore.js → docs/generated/_static/underscore.js b/docs/_static/underscore.js → docs/generated/_static/underscore.js
diff --git a/docs/_static/up-pressed.png → docs/generated/_static/up-pressed.png b/docs/_static/up-pressed.png → docs/generated/_static/up-pressed.png
diff --git a/docs/_static/up.png → docs/generated/_static/up.png b/docs/_static/up.png → docs/generated/_static/up.png
diff --git a/docs/_static/websupport.js → docs/generated/_static/websupport.js b/docs/_static/websupport.js → docs/generated/_static/websupport.js
diff --git a/docs/genindex.html → docs/generated/genindex.html b/docs/genindex.html → docs/generated/genindex.html
@@ -165,6 +165,10 @@ <h2 id="R">R</h2>
   <dt><a href="sandman.html#sandman.sandman.resource_handler">resource_handler() (in module sandman.sandman)</a>
   </dt>
 
+
+  <dt><a href="sandman.html#sandman.sandman.resource_response">resource_response() (in module sandman.sandman)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 

diff --git a/docs/index.html → docs/generated/index.html b/docs/index.html → docs/generated/index.html
diff --git a/docs/installation.html → docs/generated/installation.html b/docs/installation.html → docs/generated/installation.html
diff --git a/docs/modules.html → docs/generated/modules.html b/docs/modules.html → docs/generated/modules.html
diff --git a/docs/generated/objects.inv b/docs/generated/objects.inv
diff --git a/docs/py-modindex.html → docs/generated/py-modindex.html b/docs/py-modindex.html → docs/generated/py-modindex.html
diff --git a/docs/quickstart.html → docs/generated/quickstart.html b/docs/quickstart.html → docs/generated/quickstart.html
@@ -55,16 +55,16 @@ <h3>Navigation</h3>
   <div class="section" id="quickstart">
 <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
 <p>Create one file with the following contents (which I call <tt class="docutils literal"><span class="pre">runserver.py</span></tt>):</p>
-<div class="highlight-python"><pre>from sandman.model import register, Model
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sandman.model</span> <span class="kn">import</span> <span class="n">register</span><span class="p">,</span> <span class="n">Model</span>
 
-# Insert Models here
-# Register models here
-# register((Model1, Model2, Model3))
+<span class="c"># Insert Models here</span>
+<span class="c"># Register models here</span>
+<span class="c"># register((Model1, Model2, Model3))</span>
 
-from sandman import app, db
-app.config[&#x27;SQLALCHEMY_DATABASE_URI&#x27;] = &#x27;&lt;your database connection string (using SQLAlchemy)&#x27;
-app.run()
-```</pre>
+<span class="kn">from</span> <span class="nn">sandman</span> <span class="kn">import</span> <span class="n">app</span><span class="p">,</span> <span class="n">db</span>
+<span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s">&#39;SQLALCHEMY_DATABASE_URI&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;&lt;your database connection string (using SQLAlchemy)&#39;</span>
+<span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
+</pre></div>
 </div>
 <p>Then simply run:</p>
 <div class="highlight-python"><pre>python runserver.py</pre>

diff --git a/docs/sandman.html → docs/generated/sandman.html b/docs/sandman.html → docs/generated/sandman.html
@@ -94,12 +94,11 @@ <h1>sandman Package<a class="headerlink" href="#sandman-package" title="Permalin
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cls</strong> &#8211; User-defined class derived from <tt class="xref py py-class docutils literal"><span class="pre">sandman.Resource</span></tt> to be</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cls</strong> (<tt class="xref py py-class docutils literal"><span class="pre">sandman.Resource</span></tt> or tuple) &#8211; User-defined class derived from <tt class="xref py py-class docutils literal"><span class="pre">sandman.Resource</span></tt> to be
+registered with the endpoint returned by <tt class="xref py py-func docutils literal"><span class="pre">endpoint()</span></tt></td>
 </tr>
 </tbody>
 </table>
-<p>registered with the endpoint returned by <tt class="xref py py-func docutils literal"><span class="pre">endpoint()</span></tt>
-:type cls: <tt class="xref py py-class docutils literal"><span class="pre">sandman.Resource</span></tt> or tuple</p>
 </dd></dl>
 
 </div>
@@ -208,7 +207,7 @@ <h1>sandman Package<a class="headerlink" href="#sandman-package" title="Permalin
 
 <dl class="function">
 <dt id="sandman.sandman.resource_created_response">
-<tt class="descclassname">sandman.sandman.</tt><tt class="descname">resource_created_response</tt><big>(</big><em>resource</em><big>)</big><a class="reference internal" href="_modules/sandman/sandman.html#resource_created_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sandman.sandman.resource_created_response" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">sandman.sandman.</tt><tt class="descname">resource_created_response</tt><big>(</big><em>resource</em>, <em>current_request</em><big>)</big><a class="reference internal" href="_modules/sandman/sandman.html#resource_created_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sandman.sandman.resource_created_response" title="Permalink to this definition">¶</a></dt>
 <dd><p>Return HTTP response with status code <em>201</em>, signaling a created <em>resource</em></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -243,6 +242,11 @@ <h1>sandman Package<a class="headerlink" href="#sandman-package" title="Permalin
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="sandman.sandman.resource_response">
+<tt class="descclassname">sandman.sandman.</tt><tt class="descname">resource_response</tt><big>(</big><em>resource</em>, <em>current_request</em><big>)</big><a class="reference internal" href="_modules/sandman/sandman.html#resource_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sandman.sandman.resource_response" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="function">
 <dt id="sandman.sandman.unsupported_method_response">
 <tt class="descclassname">sandman.sandman.</tt><tt class="descname">unsupported_method_response</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sandman/sandman.html#unsupported_method_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sandman.sandman.unsupported_method_response" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/search.html → docs/generated/search.html b/docs/search.html → docs/generated/search.html
diff --git a/docs/generated/searchindex.js b/docs/generated/searchindex.js
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/installation.rst → docs/installation.rst b/doc/installation.rst → docs/installation.rst
diff --git a/doc/modules.rst → docs/modules.rst b/doc/modules.rst → docs/modules.rst
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/doc/quickstart.rst → docs/quickstart.rst b/doc/quickstart.rst → docs/quickstart.rst
@@ -13,7 +13,6 @@ Create one file with the following contents (which I call ``runserver.py``)::
     from sandman import app, db
     app.config['SQLALCHEMY_DATABASE_URI'] = '<your database connection string (using SQLAlchemy)'
     app.run()
-    ```
 
 Then simply run::
 

diff --git a/doc/sandman.rst → docs/sandman.rst b/doc/sandman.rst → docs/sandman.rst
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/sandman/test/test_sandman.py b/sandman/test/test_sandman.py
diff --git a/scripts/models.py b/scripts/models.py
@@ -0,0 +1,15 @@
+from sandman.model import register, Model
+
+class Artist(Model):
+    __tablename__ = 'Artist'
+
+class Album(Model):
+    __tablename__ = 'Album'
+
+class Playlist(Model):
+    __tablename__ = 'Playlist'
+
+class Genre(Model):
+    __tablename__ = 'Genre'
+
+register((Artist, Album, Playlist, Genre))
diff --git a/scripts/runserver.py b/scripts/runserver.py
@@ -1,5 +1,6 @@
 """Run server"""
 from sandman import app, db
-app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///chinook'
+import os
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////' + os.path.abspath(os.path.dirname(__file__)) + '/chinook'
 import models
 app.run(debug=True)