added new docs

Author: Matt George

_sources/class.txt

@@ -4,17 +4,3 @@ ResQ Classes
 ==========================================
 
 .. autoclass:: pyres.ResQ
-   :members:
-
-
-Job Classes
-=================
-
-.. autoclass:: pyres.job.Job
-   :members:
-
-Worker Classes
-=================
-
-.. autoclass:: pyres.worker.Worker
-   :members:

_sources/example.txt

@@ -4,10 +4,7 @@
 
 Let's take a real wold example of a blog where comments need to be checked for
 spam check. When the comment is saved in the database, we create a job in the
-queue with comment data. Let's take a django model in this case.
-
-.. code-block:: python
-   :linenos:
+queue with comment data. Let's take a django model in this case.::
 
     class Comment(models.Model):
         name = Model.CharField()

_sources/install.txt

@@ -3,10 +3,10 @@ Installation
 
 Requirements:
 --------------
-simplejson>=2.0.9
-itty>=0.6.2
-redis>=0.6.0
-pystache>=0.1.0
+simplejson>=2.0.9  
+itty>=0.6.2   
+redis>=0.6.0   
+pystache>=0.1.0  
 
 Make sure you install these requirements before proceeding. 
 

_sources/intro.txt

@@ -6,7 +6,11 @@ message queue. Read_ the blog post from github about how they use resque in
 production. 
 
 :synopsis: Any job which takes a little while to run can be put on a message 
-queue. Read our :doc:`Example </example>` implementation of how a PyRes can be used to spam check comments.
+queue. Read our :doc:`Example </example>` implementation of how a PyRes can be used to spam 
+check comments.
+
+
+
 
 
 .. _resque: http://github.com/defunkt/resque#readme

_theme/ADCTheme/README.html

@@ -28,9 +28,6 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="right" >
-          <a href="../../modindex.html" title="Global Module Index"
-             accesskey="M">modules</a> |</li>
         <li><a href="../../index.html">PyRes v0.4.1 documentation</a> &raquo;</li> 
       </ul>
     </div>  
@@ -122,9 +119,6 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="right" >
-          <a href="../../modindex.html" title="Global Module Index"
-             >modules</a> |</li>
         <li><a href="../../index.html">PyRes v0.4.1 documentation</a> &raquo;</li> 
       </ul>
     </div>

class.html

@@ -62,80 +62,6 @@ <h3>Navigation</h3>
 <span class="go">    # Assuming redis is running on default port with no password</span>
 </pre></div>
 </div>
-<p><strong>r</strong> is a resque object on which we can enqueue tasks.:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="go">&gt;&gt;&gt;&gt; r.enqueue(SomeClass, args)</span>
-</pre></div>
-</div>
-<p>SomeClass can be any python class with <em>perform</em> method and a <em>queue</em> 
-attribute on it.</p>
-<dl class="method">
-<dt id="pyres.ResQ.enqueue">
-<tt class="descname">enqueue</tt><big>(</big><em>klass</em>, <em>*args</em><big>)</big><a class="headerlink" href="#pyres.ResQ.enqueue" title="Permalink to this definition">¶</a></dt>
-<dd>Enqueue a job into a specific queue. Make sure the class you are passing
-has <strong>queue</strong> attribute and a <strong>perform</strong> method on it.</dd></dl>
-
-<dl class="method">
-<dt id="pyres.ResQ.info">
-<tt class="descname">info</tt><big>(</big><big>)</big><a class="headerlink" href="#pyres.ResQ.info" title="Permalink to this definition">¶</a></dt>
-<dd>Returns a dictionary of the current status of the pending jobs, 
-processed, no. of queues, no. of workers, no. of failed jobs.</dd></dl>
-
-</dd></dl>
-
-</div>
-<div class="section" id="job-classes">
-<h1>Job Classes<a class="headerlink" href="#job-classes" title="Permalink to this headline">¶</a></h1>
-<dl class="class">
-<dt id="pyres.job.Job">
-<em class="property">
-class </em><tt class="descclassname">pyres.job.</tt><tt class="descname">Job</tt><big>(</big><em>queue</em>, <em>payload</em>, <em>resq</em>, <em>worker=None</em><big>)</big><a class="headerlink" href="#pyres.job.Job" title="Permalink to this definition">¶</a></dt>
-<dd><p>Every job on the ResQ is a <em>Job</em> object which has queue and payload(all the
-args data and when its created etc).</p>
-<dl class="method">
-<dt id="pyres.job.Job.perform">
-<tt class="descname">perform</tt><big>(</big><big>)</big><a class="headerlink" href="#pyres.job.Job.perform" title="Permalink to this definition">¶</a></dt>
-<dd>This method converts payload into args and calls the <strong>perform</strong> method
-on the payload class.</dd></dl>
-
-<dl class="classmethod">
-<dt id="pyres.job.Job.reserve">
-<em class="property">
-classmethod </em><tt class="descname">reserve</tt><big>(</big><em>queue</em>, <em>res</em>, <em>worker=None</em><big>)</big><a class="headerlink" href="#pyres.job.Job.reserve" title="Permalink to this definition">¶</a></dt>
-<dd>Reserve a job on the queue. In simple marking this job so that other worker
-will not pick it up</dd></dl>
-
-</dd></dl>
-
-</div>
-<div class="section" id="worker-classes">
-<h1>Worker Classes<a class="headerlink" href="#worker-classes" title="Permalink to this headline">¶</a></h1>
-<dl class="class">
-<dt id="pyres.worker.Worker">
-<em class="property">
-class </em><tt class="descclassname">pyres.worker.</tt><tt class="descname">Worker</tt><big>(</big><em>queues=</em><span class="optional">[</span><span class="optional">]</span>, <em>server='localhost:6379'</em>, <em>password=None</em><big>)</big><a class="headerlink" href="#pyres.worker.Worker" title="Permalink to this definition">¶</a></dt>
-<dd><p>Defines a worker. The <em>pyres_worker</em> script instantiates this Worker class and
-pass a comma seperate list of queues to listen on.:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pyres.worker</span> <span class="kn">import</span> <span class="n">Worker</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">Worker</span><span class="o">.</span><span class="n">run</span><span class="p">([</span><span class="n">queue1</span><span class="p">,</span> <span class="n">queue2</span><span class="p">],</span> <span class="n">server</span><span class="o">=</span><span class="s">&quot;localhost:6379&quot;</span><span class="p">)</span>
-</pre></div>
-</div>
-<dl class="method">
-<dt id="pyres.worker.Worker.validate_queues">
-<tt class="descname">validate_queues</tt><big>(</big><big>)</big><a class="headerlink" href="#pyres.worker.Worker.validate_queues" title="Permalink to this definition">¶</a></dt>
-<dd>Checks if a worker is given atleast one queue to work on.</dd></dl>
-
-<dl class="method">
-<dt id="pyres.worker.Worker.work">
-<tt class="descname">work</tt><big>(</big><em>interval=5</em><big>)</big><a class="headerlink" href="#pyres.worker.Worker.work" title="Permalink to this definition">¶</a></dt>
-<dd><p>Invoked by run() method. work() listens on a list of queues and sleeps
-for <em>interval</em> time.</p>
-<p>default  &#8211;  5 secs</p>
-<p>Whenever a worker finds a job on the queue it first calls <tt class="docutils literal"><span class="pre">reserve</span></tt> on
-that job to make sure other worker won&#8217;t run it, then <em>Forks</em> itself to 
-work on that job.</p>
-<p>Finally process() method actually processes the job.</p>
-</dd></dl>
-
 </dd></dl>
 
 </div>
@@ -146,13 +72,6 @@ <h1>Worker Classes<a class="headerlink" href="#worker-classes" title="Permalink
       </div>
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-            <h3><a href="index.html">Table Of Contents</a></h3>
-            <ul>
-<li><a class="reference external" href="">ResQ Classes</a></li>
-<li><a class="reference external" href="#job-classes">Job Classes</a></li>
-<li><a class="reference external" href="#worker-classes">Worker Classes</a></li>
-</ul>
-
             <h4>Previous topic</h4>
             <p class="topless"><a href="example.html"
                                   title="previous chapter">EXAMPLE</a></p>

example.html

@@ -20,8 +20,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="top" title="PyRes v0.4.1 documentation" href="index.html" />
-    <link rel="next" title="ResQ Classes" href="class.html" />
-    <link rel="prev" title="Installation" href="install.html" /> 
+    <link rel="prev" title="Introduction" href="intro.html" /> 
   </head>
   <body>
     <div class="related">
@@ -31,13 +30,7 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="modindex.html" title="Global Module Index"
-             accesskey="M">modules</a> |</li>
-        <li class="right" >
-          <a href="class.html" title="ResQ Classes"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="install.html" title="Installation"
+          <a href="intro.html" title="Introduction"
              accesskey="P">previous</a> |</li>
         <li><a href="index.html">PyRes v0.4.1 documentation</a> &raquo;</li> 
       </ul>
@@ -52,48 +45,29 @@ <h3>Navigation</h3>
 <h1>EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h1>
 <p>Let&#8217;s take a real wold example of a blog where comments need to be checked for
 spam check. When the comment is saved in the database, we create a job in the
-queue with comment data. Let&#8217;s take a django model in this case.</p>
-<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><pre> 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20</pre></td><td class="code"><div class="highlight"><pre> <span class="k">class</span> <span class="nc">Comment</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
-     <span class="n">name</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">CharField</span><span class="p">()</span>
-     <span class="n">email</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">EmailField</span><span class="p">()</span>
-     <span class="n">body</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">TextField</span><span class="p">()</span>
-     <span class="n">spam</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">()</span>
-     <span class="n">queue</span> <span class="o">=</span> <span class="s">&quot;Spam&quot;</span>
+queue with comment data. Let&#8217;s take a django model in this case.:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Comment</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
+    <span class="n">name</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">CharField</span><span class="p">()</span>
+    <span class="n">email</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">EmailField</span><span class="p">()</span>
+    <span class="n">body</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">TextField</span><span class="p">()</span>
+    <span class="n">spam</span> <span class="o">=</span> <span class="n">Model</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">()</span>
+    <span class="n">queue</span> <span class="o">=</span> <span class="s">&quot;Spam&quot;</span>
 
-     <span class="nd">@staticmethod</span>
-     <span class="k">def</span> <span class="nf">perform</span><span class="p">(</span><span class="n">comment_id</span><span class="p">):</span>
-         <span class="n">comment</span> <span class="o">=</span> <span class="n">Comment</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="n">comment_id</span><span class="p">)</span>
-         <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;comment_author_email&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">email</span><span class="p">,</span>
-                   <span class="s">&quot;comment_content&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">body</span><span class="p">,</span>
-                   <span class="s">&quot;comment_author_name&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
-                   <span class="s">&quot;request_ip&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">author_ip</span><span class="p">}</span>
-         <span class="n">x</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">&quot;http://apikey.rest.akismet.com/1.1/comment-check&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
-         <span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&quot;true&quot;</span><span class="p">:</span>
-             <span class="n">comment</span><span class="o">.</span><span class="n">spam</span> <span class="o">=</span> <span class="bp">True</span>
-         <span class="k">else</span><span class="p">:</span>
-             <span class="n">comment</span><span class="o">.</span><span class="n">spam</span> <span class="o">=</span> <span class="bp">False</span>
-         <span class="n">comment</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
+    <span class="nd">@staticmethod</span>
+    <span class="k">def</span> <span class="nf">perform</span><span class="p">(</span><span class="n">comment_id</span><span class="p">):</span>
+        <span class="n">comment</span> <span class="o">=</span> <span class="n">Comment</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="n">comment_id</span><span class="p">)</span>
+        <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;comment_author_email&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">email</span><span class="p">,</span>
+                  <span class="s">&quot;comment_content&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">body</span><span class="p">,</span>
+                  <span class="s">&quot;comment_author_name&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
+                  <span class="s">&quot;request_ip&quot;</span><span class="p">:</span> <span class="n">comment</span><span class="o">.</span><span class="n">author_ip</span><span class="p">}</span>
+        <span class="n">x</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">&quot;http://apikey.rest.akismet.com/1.1/comment-check&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&quot;true&quot;</span><span class="p">:</span>
+            <span class="n">comment</span><span class="o">.</span><span class="n">spam</span> <span class="o">=</span> <span class="bp">True</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">comment</span><span class="o">.</span><span class="n">spam</span> <span class="o">=</span> <span class="bp">False</span>
+        <span class="n">comment</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
 </pre></div>
-</td></tr></table></div>
+</div>
 <p>You can convert your existing class to be compatible with Pyres. All you need
 to do is add a &#64;queue&#64; variable and define a &#64;perform&#64; method on the class.</p>
 <p>To insert a job into the queue you need to do something like this::</p>
@@ -116,11 +90,8 @@ <h1>EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headli
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
             <h4>Previous topic</h4>
-            <p class="topless"><a href="install.html"
-                                  title="previous chapter">Installation</a></p>
-            <h4>Next topic</h4>
-            <p class="topless"><a href="class.html"
-                                  title="next chapter">ResQ Classes</a></p>
+            <p class="topless"><a href="intro.html"
+                                  title="previous chapter">Introduction</a></p>
             <h3>This Page</h3>
             <ul class="this-page-menu">
               <li><a href="_sources/example.txt"
@@ -150,13 +121,7 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="modindex.html" title="Global Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="class.html" title="ResQ Classes"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="install.html" title="Installation"
+          <a href="intro.html" title="Introduction"
              >previous</a> |</li>
         <li><a href="index.html">PyRes v0.4.1 documentation</a> &raquo;</li> 
       </ul>