Skip to main content

Python Client for Riak

Build Status

Build Status

Documentation

Documentation for the Riak Python Client Library is available here.

Documentation for Riak is available here.

Repository Cloning

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.

Installation

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.

Riak TS (Timeseries)

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.

From Source

python setup.py install

There are additional dependencies on Python packages setuptools and protobuf.

From PyPI

Official packages are signed and published to PyPI.

To install from PyPI directly you can use pip.

pip install riak

Testing

Unit Tests

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

Integration Tests

You have two options to run Riak locally - either build from source, or use a pre-installed Riak package.

Source

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

Source build documentation.

When building from source, the protocol buffers port will be 8087 and HTTP will be 8098.

Package

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.

Running Integration Tests

  • Ensure you’ve initialized this repo’s submodules:

git submodule update --init
  • Run the following:

./tools/setup-riak
make integration-test

Contributors

  • Andrew Thompson

  • Andy Gross

  • Armon Dadgar

  • Brett Hazen

  • Brett Hoerner

  • Brian Roach

  • Bryan Fink

  • Daniel Lindsley

  • Daniel Néri

  • Daniel Reverri

  • Dan Root

  • David Basden

  • David Delassus

  • David Koblas

  • Dmitry Rozhkov

  • Eric Florenzano

  • Eric Moritz

  • Filip de Waard

  • Gilles Devaux

  • Greg Nelson

  • Gregory Burd

  • Greg Stein

  • Ian Plosker

  • Jayson Baird

  • Jeffrey Massung

  • Jon Meredith

  • Josip Lisec

  • Justin Sheehy

  • Kevin Smith

  • Luke Bakken

  • Mark Erdmann

  • Mark Phillips

  • Mathias Meyer

  • Matt Heitzenroder

  • Matt Lohier

  • Mikhail Sobolev

  • Reid Draper

  • Russell Brown

  • Rusty Klophaus

  • Rusty Klophaus

  • Scott Lystig Fritchie

  • Sean Cribbs

  • Shuhao Wu

  • Silas Sewell

  • Socrates Lee

  • Soren Hansen

  • Sreejith Kesavan

  • Timothée Peignier

  • `tobixx <https://github.com/tobixx>`__

  • Tin Tvrtković

  • Vitaly Shestovskiy

  • William Kral

  • Yasser Souri

Release files for riak 2.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for riak 2.7.0
File Size Uploaded
riak-2.7.0.tar.gz 194.1 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for riak 2.7.0
File
riak-2.7.0-py3.5.egg Legacy Egg format - - Details
riak-2.7.0-py3.4.egg Legacy Egg format - - Details
riak-2.7.0-py3.3.egg Legacy Egg format - - Details
riak-2.7.0-py2.7.egg Legacy Egg format - - Details

Total release size: 2.0 MB

Release files / riak-2.7.0.tar.gz

Download URL riak-2.7.0.tar.gz
Size 194.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1c676b90fef357f60adc135ccd180ac28945b61b1367198a2a63df86e9bac1ca
BLAKE2b-256 checksum
How to use checksums
85f51a571ddc68f1dc7148f083f25210b7c7de8a9bc69d0ea5683ca6f3c189a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / riak-2.7.0-py3.5.egg

Download URL riak-2.7.0-py3.5.egg
Size 462.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
13b9bd65ce0f5a87ea0956ebec434848caf9c2b819db5500360601b69866b861
BLAKE2b-256 checksum
How to use checksums
737ee5efbfd28e4b168c6fe2cf9aa34eca6c3343e6afb340edea865fded68ef9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / riak-2.7.0-py3.4.egg

Download URL riak-2.7.0-py3.4.egg
Size 463.0 kB
Tags Egg
SHA-256 checksum
How to use checksums
3d6b5df273088f20aec03a16a4e35227c0537a4fe993d073fc4a26a98689745d
BLAKE2b-256 checksum
How to use checksums
507b4dfae10b1f091d91f8b83743e81c9f41b8bfc04933c4dd11539476b20c11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / riak-2.7.0-py3.3.egg

Download URL riak-2.7.0-py3.3.egg
Size 470.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
2e814d8c50bd103439e64cd1afe0935d62f445424d519cbb3fc956d6e1123bdf
BLAKE2b-256 checksum
How to use checksums
3d385628720ed25071082808be475c0fe50a45f10ad6e97524f7371e4fdb5cd6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / riak-2.7.0-py2.7.egg

Download URL riak-2.7.0-py2.7.egg
Size 451.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
96183e54e8d1dfb94470d7c9c3aa55be772688e4984377aa30b81a239a4035c1
BLAKE2b-256 checksum
How to use checksums
e11233b0bbe23c78b7c3e766095ab78b9a1c4051a515dd47459c6b792fdb4ec6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

2.7.0 This release

5 release files

2.6.1

5 release files

2.5.5

5 release files

2.5.4

5 release files

2.5.3

5 release files

2.5.2

5 release files

2.4.2

5 release files

2.4.1

5 release files

2.4.0

5 release files

2.3.0

5 release files

2.2.0

5 release files

2.1.0

3 release files

2.0.3

3 release files

2.0.2

3 release files

2.0.1

3 release files

2.0.0

3 release files

1.5.2

3 release files

1.5.1

3 release files

1.5.0

3 release files

1.4.1

3 release files

1.4.0

3 release files

1.3.0

3 release files

1.2.2

4 release files

1.2.1

4 release files

1.1.1

3 release files

1.1.0

3 release files

1.0.1

3 release files

1.0.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page