Download 
How to install sandsnake
- Download and install ActivePython
- Open Command Prompt
- Type
pypm install sandsnake
Lastest release
version 0.1.2 on May 11th, 2013
Introduction
Sandsnake is a sorted index implemented in python and uses redis as a backend. It was originally implemented to be used as an indexing system for Sunspear.
Requirements
Required
Requirements should be handled by setuptools, but if they are not, you will need the following Python packages:
- nydus
- redis
- dateutil
Optional
- hiredis
sandsnake.create_sandsnake_backend
Creates an sandsnake object that allows to to store and retrieve indexes:
>>> from sandsnake import create_sandsnake_backend
>>>
>>> sandsnake = create_sandsnake_backend({
>>> 'backend': 'sandsnake.backends.redis.Redis',
>>> 'settings': {
>>> 'defaults': {
>>> 'host': 'localhost',
>>> 'port': 6379,
>>> 'db': 0,
>>> },
>>> 'hosts': [{'db': 0}, {'db': 1}, {'host': 'redis.example.org'}]
>>> },
>>> })
Internally, the Redis sandsnake backend uses nydus to distribute your indexes data over your cluster of redis instances.
There are two required arguements:
- backend: full path to the backend class, which should extend sandsnake.backends.base.BaseSandsnakeBackend
- settings: settings required to initialize the backend. For the Redis backend, this is a list of hosts in your redis cluster.
Example Usage
Redis
from sandsnake import create_sandsnake_backend
import datetime
sandsnake = create_sandsnake_backend({
"backend": "sandsnake.backends.redis.Redis",
"settings": {
"hosts": [{"db": 5}]
},
})
#add a value of "abc" to the ``index`` for an ``object``
sandsnake.add("user:1", "homefeed", "abc")
sandsnake.add("user:1", ["homefeed", "recogfeed"], "abc")
successful builds
Builds marked with
a lock icon are only available via PyPM to users with a current