Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

use .rst instead of .md for README to accomodate pypi

  • Loading branch information...
commit f1e24638b546bc609380a693ee8bb9784abdecf0 1 parent 619c133
Salimane Adjao Moustapha authored
Showing with 54 additions and 33 deletions.
  1. +46 −26 README.md → README.rst
  2. +1 −1  rediscluster/__init__.py
  3. +7 −6 setup.py
72 README.md → README.rst
View
@@ -3,40 +3,55 @@ rediscluster-py
a Python interface to a Cluster of Redis key-value store.
-## Project Goals
+Project Goals
+-------------
-The goal is to be a drop in replacement of redis-py when you would like to shard your data into a cluster of redis servers.
-rediscluster-py is based on the awesome [redis-py](https://github.com/andymccurdy/redis-py.git) StrictRedis Api, thus the original api commands
-would work without problems within the context of a cluster of redis servers
+The goal is to be a drop in replacement of redis-py when you would like
+to shard your data into a cluster of redis servers. rediscluster-py is
+based on the awesome
+`redis-py <https://github.com/andymccurdy/redis-py.git>`_ StrictRedis
+Api, thus the original api commands would work without problems within
+the context of a cluster of redis servers
-## Travis CI
+Travis CI
+---------
-Currently, rediscluster-py is being tested via travis ci for python version 2.6, 2.7 and 3.2:
-[![Build Status](https://secure.travis-ci.org/salimane/rediscluster-py.png?branch=master)](http://travis-ci.org/salimane/rediscluster-py)
+Currently, rediscluster-py is being tested via travis ci for python
+version 2.6, 2.7 and 3.2: |Build Status|
+Installation
+------------
-## Installation
+::
$ sudo pip install rediscluster
or alternatively (you really should be using pip though):
+::
+
$ sudo easy_install rediscluster
From source:
+::
+
$ sudo python setup.py install
-
-## Running Tests
+
+Running Tests
+-------------
+
+::
$ git clone https://github.com/salimane/rediscluster-py.git
$ cd rediscluster-py
$ vi tests/config.py
$ ./run_tests
+Getting Started
+---------------
-
-## Getting Started
+::
>>> import rediscluster
>>> cluster = {
@@ -58,29 +73,34 @@ From source:
>>> r.get('foo')
'bar'
+Tagged keys
+-----------
-##Tagged keys
+In order to specify your own hash key (so that related keys can all land
+on a given node), you pass a list where you’d normally pass a scalar.
+The first element of the list is the key to use for the hash and the
+second is the real key that should be fetched/modify:
-In order to specify your own hash key (so that related keys can all land on a given node),
-you pass a list where you’d normally pass a scalar. The first element of the list is the key to use for the hash
-and the second is the real key that should be fetched/modify:
+::
>>> r.get(["userinfo", "foo"])
-
-In that case “userinfo” is the hash key but “foo” is still the name of the key that is fetched from the redis node
-that “userinfo” hashes to.
-
-## Information
+In that case “userinfo” is the hash key but “foo” is still the name of
+the key that is fetched from the redis node that “userinfo” hashes to.
-* Code: `git clone git://github.com/salimane/rediscluster-py.git`
-* Home: <http://github.com/salimane/rediscluster-py>
-* Bugs: <http://github.com/salimane/rediscluster-py/issues>
+Information
+-----------
+- Code: ``git clone git://github.com/salimane/rediscluster-py.git``
+- Home: http://github.com/salimane/rediscluster-py
+- Bugs: http://github.com/salimane/rediscluster-py/issues
Author
------
-rediscluster-py is developed and maintained by Salimane Adjao Moustapha (me@salimane.com).
-It can be found here: http://github.com/salimane/rediscluster-py
+rediscluster-py is developed and maintained by Salimane Adjao Moustapha
+(me@salimane.com). It can be found here:
+http://github.com/salimane/rediscluster-py
+.. |Build Status| image:: https://secure.travis-ci.org/salimane/rediscluster-py.png?branch=master
+ :target: http://travis-ci.org/salimane/rediscluster-py
2  rediscluster/__init__.py
View
@@ -10,7 +10,7 @@
WatchError,
)
-__version__ = '0.2.3'
+__version__ = '0.2.4'
VERSION = tuple(map(int, __version__.split('.')))
__all__ = [
13 setup.py
View
@@ -1,5 +1,4 @@
#!/usr/bin/env python
-import os
from rediscluster import __version__
try:
@@ -17,9 +16,11 @@
func = lambda name, enc = ascii: {True: enc}.get(name == 'mbcs')
codecs.register(func)
-f = open(os.path.join(os.path.dirname(__file__), 'README.md'))
-long_description = f.read()
-f.close()
+with open('README.rst') as f:
+ long_description = f.read()
+
+with open('LICENSE') as f:
+ license = f.read()
setup(
name='rediscluster',
@@ -36,8 +37,8 @@
author_email='me@salimane.com',
maintainer='Salimane Adjao Moustapha',
maintainer_email='me@salimane.com',
- keywords=['Redis Cluster', 'Redis', 'cluster of key-value store'],
- license='MIT',
+ keywords=['rediscluster', 'redis', 'nosql', 'cluster', 'key value'],
+ license=license,
packages=['rediscluster'],
test_suite='tests.all_tests',
classifiers=[
Please sign in to comment.
Something went wrong with that request. Please try again.