Documentation for the Riak Python Client Library is available here. The documentation source is found in docs/ subdirectory and can be built with Sphinx.
Documentation for Riak is available at http://docs.basho.com/riak/latest
The recommended version of Python for use with this client is Python 2.7.
You must have Protocol Buffers installed before you can install the Riak Client. From the Riak Python Client root directory, execute:
python setup.py install
There is an additional dependency on the Python package setuptools. Please install setuptools first, e.g. port install py27-setuptools
for OS X and MacPorts.
To run the unit tests against a Riak server (with default TCP port configuration) on localhost, execute:
python setup.py test
If you don't have Riak Search enabled you can set the SKIP_SEARCH
environment variable to skip that tests.
If your Riak server isn't running on localhost, use the environment variables RIAK_TEST_HOST
and RIAK_TEST_HTTP_PORT
and RIAK_TEST_PB_PORT=8087
to specify where to find the Riak server.