Skip to content

Commit a724e3b

Browse files
committed
adding more docs on installation and tests
1 parent 7eb9a28 commit a724e3b

File tree

4 files changed

+46
-1
lines changed

4 files changed

+46
-1
lines changed

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ Contents:
1212
:maxdepth: 2
1313

1414
intro
15+
install
1516
example
1617
class
18+
tests
1719

1820
Indices and tables
1921
==================

docs/source/install.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Installation
2+
===============
3+
4+
Requirements:
5+
--------------
6+
simplejson>=2.0.9
7+
itty>=0.6.2
8+
redis>=0.6.0
9+
pystache>=0.1.0
10+
11+
Make sure you install these requirements before proceeding.
12+
13+
.. todo:: Need to point to notes on redis installation and get python-redis.
14+
15+
16+
To install pyres.::
17+
18+
$ git clone git://github.com/binarydud/pyres.git
19+
$ cd pyres
20+
$ python setup.py build
21+
$ python setup.py install
22+
23+
Might need to run as sudo to install.
24+
25+
26+

docs/source/tests.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Tests
2+
=======
3+
4+
PyRes comes with a test suite which connects to a local redis server and
5+
creates a couple of *Queues* and *jobs*.
6+
7+
To run tests make sure you have nose_ installed.::
8+
9+
$ easy_install nose
10+
$ redis-server [PATH_TO_YOUR_REDIS_CONFIG]
11+
$ nosetests
12+
13+
Add **-v** flag if you want verbose output.
14+
15+
.. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.1/

pyres/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@ class ResQ(object):
4747
Example usage::
4848
4949
>>> from pyres import *
50-
>>> r = ResQ()
50+
>>> r = ResQ(server="192.168.1.10:6379", password="some_pwd")
5151
# Assuming redis is running on default port with no password
52+
53+
5254
"""
5355
def __init__(self, server="localhost:6379", password=None,
5456
timeout=None, retry_connection=True):

0 commit comments

Comments
 (0)