Merge remote branch 'yashh/gh-pages' into gh-pages

Author: Matt George

.gitignore

@@ -0,0 +1 @@
+*.pyc

.nojekyll

@@ -0,0 +1,35 @@
+==============
+How To Install
+==============
+
+Install in Sphinx
+-----------------
+
+Copy this directory into the ``sphinx/templates`` directory where Shpinx is installed. For example, a standard install of sphinx on Mac OS X is at ``/Library/Python/2.6/site-packages/Sphinx-0.6.3-py2.6.egg/``
+
+Install Somewhere Else
+----------------------
+
+If you want to install this theme somewhere else, you will have to modify the ``conf.py`` file. ::
+
+    templates_path = ['/absolute/path/to/dir/','relative/path/']
+
+Making Sphinx Use the Theme
+---------------------------
+
+Edit the ``conf.py`` file and make the following setting: ::
+
+    html_theme = 'ADCtheme'
+
+Screen Shots
+------------
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn1.png
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn2.png
+
+To Do
+-----
+
+ * Gotta get the javascript working so the Table of Contents is hide-able.
+ * Probably lots of css cleanup.

_sources/_theme/ADCTheme/README.txt

@@ -0,0 +1,20 @@
+.. module:: pyres
+
+ResQ Classes
+==========================================
+
+.. autoclass:: pyres.ResQ
+   :members:
+
+
+Job Classes
+=================
+
+.. autoclass:: pyres.job.Job
+   :members:
+
+Worker Classes
+=================
+
+.. autoclass:: pyres.worker.Worker
+   :members:

_sources/class.txt

@@ -0,0 +1,50 @@
+=========
+ EXAMPLE
+=========
+
+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:
+
+    class Comment(models.Model):
+        name = Model.CharField()
+        email = Model.EmailField()
+        body = Model.TextField()
+        spam = Model.BooleanField()
+        queue = "Spam"
+    
+        @staticmethod
+        def perform(comment_id):
+            comment = Comment.objects.get(pk=comment_id)
+            params = {"comment_author_email": comment.user.email, 
+                      "comment_content": comment.body,
+                      "comment_author_name": comment.user.name,
+                      "request_ip": comment.author_ip}
+            x = urllib.urlopen("http://apikey.rest.akismet.com/1.1/comment-check", params)
+            if x == "true":
+                comment.spam = True
+            else:
+                comment.spam = False
+            comment.save()
+
+You can convert your existing class to be compatible with Pyres. All you need 
+to do is add a @queue@ variable and define a @perform@ method on the class. 
+
+To insert a job into the queue you need to do something like this:::
+
+    from pyres import ResQ
+    r = Resq()
+    r.enqueue(Spam, 23)   # Passing the comment id 23
+
+This puts a job into the queue **Spam**. Now we need to fire off our workers. 
+In the **scripts** folder there is an executable::
+
+    $ ./pyres_worker Spam
+
+
+Just pass a comma separated list of queues the worker should poll.
+
+

_sources/example.txt

@@ -0,0 +1,26 @@
+.. PyRes documentation master file, created by
+   sphinx-quickstart on Wed Jan  6 15:11:19 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyRes's documentation!
+=================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+   install
+   example
+   class
+   tests
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

_sources/index.txt

@@ -0,0 +1,26 @@
+Installation
+===============
+
+Requirements:
+--------------
+simplejson>=2.0.9
+itty>=0.6.2
+redis>=0.6.0
+pystache>=0.1.0
+
+Make sure you install these requirements before proceeding. 
+
+.. todo:: Need to point to notes on redis installation and get python-redis.
+
+
+To install pyres.::
+
+    $ git clone git://github.com/binarydud/pyres.git
+    $ cd pyres
+    $ python setup.py build
+    $ python setup.py install
+
+Might need to run as sudo to install.
+
+
+

_sources/install.txt

@@ -0,0 +1,14 @@
+Introduction
+============
+
+PyRes is a resque_ clone built in python. Resque is used by Github as their 
+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.
+
+
+.. _resque: http://github.com/defunkt/resque#readme
+.. _Read: http://github.com/blog/542-introducing-resque
+

_sources/intro.txt

@@ -0,0 +1,15 @@
+Tests
+=======
+
+PyRes comes with a test suite which connects to a local redis server and 
+creates a couple of *Queues* and *jobs*. 
+
+To run tests make sure you have nose_ installed.::
+
+    $ easy_install nose
+    $ redis-server [PATH_TO_YOUR_REDIS_CONFIG]
+    $ nosetests
+
+Add **-v** flag if you want verbose output.
+
+.. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.1/