Merge branch 'master' of github.com:yashh/pyres

Author: yashh

docs/source/class.rst

@@ -0,0 +1,6 @@
+.. module:: pyres
+
+ResQ Classes
+==========================================
+
+.. autoclass:: pyres.ResQ

docs/source/conf.py

@@ -16,7 +16,7 @@
 # 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('.'))
+sys.path.append(os.path.abspath(os.path.dirname(__file__+'/../../../')))
 
 # -- General configuration -----------------------------------------------------
 

docs/source/index.rst

@@ -12,6 +12,10 @@ Contents:
    :maxdepth: 2
 
    intro
+   install
+   example
+   class
+   tests
 
 Indices and tables
 ==================

docs/source/install.rst

@@ -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.
+
+
+

docs/source/tests.rst

@@ -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/

pyres/__init__.py

@@ -41,7 +41,17 @@ def str_to_class(s):
         return None
 
 class ResQ(object):
+    """ResQ class which defines the Queue object to enqueue jobs into various
+    queues.
     
+    Example usage::
+
+        >>> from pyres import *
+        >>> r = ResQ(server="192.168.1.10:6379", password="some_pwd")
+            # Assuming redis is running on default port with no password
+    
+    
+    """
     def __init__(self, server="localhost:6379", password=None, 
                  timeout=None, retry_connection=True):
         self.timeout = timeout