Python client for Riak
Project description
========================
Python Client for Riak
========================
.. image:: https://secure.travis-ci.org/basho/riak-python-client.png?branch=master
:target: http://travis-ci.org/basho/riak-python-client
Documentation
=============
`Documentation for the Riak Python Client Library <http://basho.github.io/riak-python-client/index.html>`_ is available here.
The documentation source is found in `docs/ subdirectory
<https://github.com/basho/riak-python-client/tree/master/docs>`_ and can be
built with `Sphinx <http://sphinx.pocoo.org/>`_.
Documentation for Riak is available at http://docs.basho.com/riak/latest
Install
=======
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.
Unit Test
=========
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 <http://wiki.basho.com/Riak-Search.html>`_ 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.
Python Client for Riak
========================
.. image:: https://secure.travis-ci.org/basho/riak-python-client.png?branch=master
:target: http://travis-ci.org/basho/riak-python-client
Documentation
=============
`Documentation for the Riak Python Client Library <http://basho.github.io/riak-python-client/index.html>`_ is available here.
The documentation source is found in `docs/ subdirectory
<https://github.com/basho/riak-python-client/tree/master/docs>`_ and can be
built with `Sphinx <http://sphinx.pocoo.org/>`_.
Documentation for Riak is available at http://docs.basho.com/riak/latest
Install
=======
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.
Unit Test
=========
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 <http://wiki.basho.com/Riak-Search.html>`_ 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
riak-2.0.3.tar.gz
(106.9 kB
view hashes)
Built Distributions
riak-2.0.3-py2.7.egg
(256.0 kB
view hashes)
riak-2.0.3-py2.6.egg
(257.5 kB
view hashes)