README

                        Python Client for Riak
                        ======================


This is the Python client for Riak.

Table of Contents
=================
1 Documentation
2 Repositories
3 Building
4 Testing


1 Documentation
~~~~~~~~~~~~~~~~

  Documentation for the Python library can be found in the docs
  subdirectory here.

  Documentation for use of Riak clients in general can be found at

  [https://wiki.basho.com/display/RIAK/Client+Libraries]

2 Repositories
~~~~~~~~~~~~~~~

  The official source code for this client can be retrieved from

  [http://bitbucket.org/basho/riak-python-client]

  Riak can be obtained pre-built from

  [http://downloads.basho.com/riak/]

  or as source from

  [http://bitbucket.org/basho/riak]

3 Installing
~~~~~~~~~~

    You must have Protocol buffers installed before you can install this, 
    you can get that from:

    [http://code.google.com/p/protobuf/downloads/list]

    python setup.py install

4 Running Unit Tests
~~~~~~~~~~
    python setup.py test