Documentation for the Riak Python Client Library is available here.
Documentation for Riak is available here.
NOTE: please clone this repository using the --recursive
argument to git clone
or follow the clone with git submodule update --init
. This repository uses two submodules.
The recommended versions of Python for use with this client are Python 2.7.8
(or greater, 2.7.11
as of 2016-06-21
), 3.3.x
, 3.4.x
and 3.5.x
. The latest version from each series should be preferred. Older versions of the Python 2.7.X
and 3.X
series should be used with caution as they are not covered by integration tests.
You must use version 2.7.11
, 3.4.4
or 3.5.1
(or greater within a version series). Otherwise you will be affected by this Python bug.
python setup.py install
There are additional dependencies on Python packages setuptools
and protobuf
.
Official packages are signed and published to PyPI.
To install from PyPI directly you can use pip
.
pip install riak
Unit tests will be executed via tox
if it is in your PATH
, otherwise by the python2
and (if available), python3
executables:
make unit-test
You have two options to run Riak locally - either build from source, or use a pre-installed Riak package.
To setup the default test configuration, build a Riak node from a clone of github.com/basho/riak
:
# check out latest release tag
git checkout riak-2.1.4
make locked-deps
make rel
When building from source, the protocol buffers port will be 8087
and HTTP will be 8098
.
Install using your platform's package manager (docs)
When installing from a package, the protocol buffers port will be 8087
and HTTP will be 8098
.
git submodule update --init
./tools/setup-riak
make integration-test
tobixx