Python Client for Riak
======================
Build Status
------------
|Build Status|
Documentation
-------------
`Documentation for the Riak Python Client
Library <http://basho.github.io/riak-python-client/index.html>`__ is
available
`here <http://basho.github.io/riak-python-client/index.html>`__.
Documentation for Riak is available
`here <http://docs.basho.com/riak/latest>`__.
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 <https://bugs.python.org/issue23517>`__.
From Source
-----------
.. code:: sh
python setup.py install
There are additional dependencies on Python packages ``setuptools`` and
``protobuf``.
From PyPI
---------
Official packages are signed and published to
`PyPI <https://pypi.python.org/pypi/riak>`__.
To install from `PyPI <https://pypi.python.org/pypi/riak>`__ directly
you can use ``pip``.
.. code:: sh
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:
.. code:: sh
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``:
.. code:: sh
# check out latest release tag
git checkout riak-2.1.4
make locked-deps
make rel
`Source build
documentation <http://docs.basho.com/riak/kv/latest/setup/installing/source/>`__.
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 <http://docs.basho.com/riak/kv/latest/setup/installing/>`__)
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:
.. code:: sh
git submodule update --init
- Run the following:
.. code:: sh
./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 <https://github.com/daroot>`__
- `David Basden <https://github.com/dbasden>`__
- `David Delassus <https://github.com/linkdd>`__
- 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 <https://github.com/lukebakken>`__
- Mark Erdmann
- Mark Phillips
- Mathias Meyer
- Matt Heitzenroder
- `Matt Lohier <https://github.com/aquam8>`__
- 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ć <https://github.com/Tinche>`__
- `Vitaly Shestovskiy <https://github.com/lamp0chka>`__
- William Kral
- `Yasser Souri <https://github.com/yassersouri>`__
.. |Build Status| image:: https://travis-ci.org/basho/riak-python-client.svg?branch=master
:target: https://travis-ci.org/basho/riak-python-client
Raw data
{
"_id": null,
"home_page": "https://github.com/basho/riak-python-client",
"name": "riak",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Basho Technologies",
"author_email": "clients@basho.com",
"download_url": "https://files.pythonhosted.org/packages/85/f5/1a571ddc68f1dc7148f083f25210b7c7de8a9bc69d0ea5683ca6f3c189a9/riak-2.7.0.tar.gz",
"platform": "Platform Independent",
"description": "Python Client for Riak\n======================\n\nBuild Status\n------------\n\n|Build Status|\n\nDocumentation\n-------------\n\n`Documentation for the Riak Python Client\nLibrary <http://basho.github.io/riak-python-client/index.html>`__ is\navailable\n`here <http://basho.github.io/riak-python-client/index.html>`__.\n\nDocumentation for Riak is available\n`here <http://docs.basho.com/riak/latest>`__.\n\nRepository Cloning\n------------------\n\n*NOTE*: please clone this repository using the ``--recursive`` argument\nto ``git clone`` or follow the clone with\n``git submodule update --init``. This repository uses two submodules.\n\nInstallation\n============\n\nThe recommended versions of Python for use with this client are Python\n``2.7.8`` (or greater, ``2.7.11`` as of ``2016-06-21``), ``3.3.x``,\n``3.4.x`` and ``3.5.x``. The latest version from each series should be\npreferred. Older versions of the Python ``2.7.X`` and ``3.X`` series\nshould be used with caution as they are not covered by integration\ntests.\n\nRiak TS (Timeseries)\n--------------------\n\nYou must use version ``2.7.11``, ``3.4.4`` or ``3.5.1`` (or greater\nwithin a version series). Otherwise you will be affected by `this Python\nbug <https://bugs.python.org/issue23517>`__.\n\nFrom Source\n-----------\n\n.. code:: sh\n\n python setup.py install\n\nThere are additional dependencies on Python packages ``setuptools`` and\n``protobuf``.\n\nFrom PyPI\n---------\n\nOfficial packages are signed and published to\n`PyPI <https://pypi.python.org/pypi/riak>`__.\n\nTo install from `PyPI <https://pypi.python.org/pypi/riak>`__ directly\nyou can use ``pip``.\n\n.. code:: sh\n\n pip install riak\n\nTesting\n=======\n\nUnit Tests\n----------\n\nUnit tests will be executed via ``tox`` if it is in your ``PATH``,\notherwise by the ``python2`` and (if available), ``python3``\nexecutables:\n\n.. code:: sh\n\n make unit-test\n\nIntegration Tests\n-----------------\n\nYou have two options to run Riak locally - either build from source, or\nuse a pre-installed Riak package.\n\nSource\n~~~~~~\n\nTo setup the default test configuration, build a Riak node from a clone\nof ``github.com/basho/riak``:\n\n.. code:: sh\n\n # check out latest release tag\n git checkout riak-2.1.4\n make locked-deps\n make rel\n\n`Source build\ndocumentation <http://docs.basho.com/riak/kv/latest/setup/installing/source/>`__.\n\nWhen building from source, the protocol buffers port will be ``8087``\nand HTTP will be ``8098``.\n\nPackage\n~~~~~~~\n\nInstall using your platform's package manager\n(`docs <http://docs.basho.com/riak/kv/latest/setup/installing/>`__)\n\nWhen installing from a package, the protocol buffers port will be\n``8087`` and HTTP will be ``8098``.\n\nRunning Integration Tests\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Ensure you've initialized this repo's submodules:\n\n.. code:: sh\n\n git submodule update --init\n\n- Run the following:\n\n.. code:: sh\n\n ./tools/setup-riak\n make integration-test\n\nContributors\n------------\n\n- Andrew Thompson\n- Andy Gross\n- Armon Dadgar\n- Brett Hazen\n- Brett Hoerner\n- Brian Roach\n- Bryan Fink\n- Daniel Lindsley\n- Daniel N\u00e9ri\n- Daniel Reverri\n- `Dan Root <https://github.com/daroot>`__\n- `David Basden <https://github.com/dbasden>`__\n- `David Delassus <https://github.com/linkdd>`__\n- David Koblas\n- Dmitry Rozhkov\n- Eric Florenzano\n- Eric Moritz\n- Filip de Waard\n- Gilles Devaux\n- Greg Nelson\n- Gregory Burd\n- Greg Stein\n- Ian Plosker\n- Jayson Baird\n- Jeffrey Massung\n- Jon Meredith\n- Josip Lisec\n- Justin Sheehy\n- Kevin Smith\n- `Luke Bakken <https://github.com/lukebakken>`__\n- Mark Erdmann\n- Mark Phillips\n- Mathias Meyer\n- Matt Heitzenroder\n- `Matt Lohier <https://github.com/aquam8>`__\n- Mikhail Sobolev\n- Reid Draper\n- Russell Brown\n- Rusty Klophaus\n- Rusty Klophaus\n- Scott Lystig Fritchie\n- Sean Cribbs\n- Shuhao Wu\n- Silas Sewell\n- Socrates Lee\n- Soren Hansen\n- Sreejith Kesavan\n- Timoth\u00e9e Peignier\n- ```tobixx`` <https://github.com/tobixx>`__\n- `Tin Tvrtkovi\u0107 <https://github.com/Tinche>`__\n- `Vitaly Shestovskiy <https://github.com/lamp0chka>`__\n- William Kral\n- `Yasser Souri <https://github.com/yassersouri>`__\n\n.. |Build Status| image:: https://travis-ci.org/basho/riak-python-client.svg?branch=master\n :target: https://travis-ci.org/basho/riak-python-client\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Python client for Riak",
"version": "2.7.0",
"project_urls": {
"Homepage": "https://github.com/basho/riak-python-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e11233b0bbe23c78b7c3e766095ab78b9a1c4051a515dd47459c6b792fdb4ec6",
"md5": "cecff5beccf02991c2b1812d2a27ebe8",
"sha256": "96183e54e8d1dfb94470d7c9c3aa55be772688e4984377aa30b81a239a4035c1"
},
"downloads": -1,
"filename": "riak-2.7.0-py2.7.egg",
"has_sig": false,
"md5_digest": "cecff5beccf02991c2b1812d2a27ebe8",
"packagetype": "bdist_egg",
"python_version": "2.7",
"requires_python": null,
"size": 451076,
"upload_time": "2016-12-12T22:51:24",
"upload_time_iso_8601": "2016-12-12T22:51:24.419288Z",
"url": "https://files.pythonhosted.org/packages/e1/12/33b0bbe23c78b7c3e766095ab78b9a1c4051a515dd47459c6b792fdb4ec6/riak-2.7.0-py2.7.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d385628720ed25071082808be475c0fe50a45f10ad6e97524f7371e4fdb5cd6",
"md5": "804ebf43e294d83e301e392b5ef8e2d4",
"sha256": "2e814d8c50bd103439e64cd1afe0935d62f445424d519cbb3fc956d6e1123bdf"
},
"downloads": -1,
"filename": "riak-2.7.0-py3.3.egg",
"has_sig": false,
"md5_digest": "804ebf43e294d83e301e392b5ef8e2d4",
"packagetype": "bdist_egg",
"python_version": "3.3",
"requires_python": null,
"size": 470309,
"upload_time": "2016-12-12T22:51:28",
"upload_time_iso_8601": "2016-12-12T22:51:28.328511Z",
"url": "https://files.pythonhosted.org/packages/3d/38/5628720ed25071082808be475c0fe50a45f10ad6e97524f7371e4fdb5cd6/riak-2.7.0-py3.3.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "507b4dfae10b1f091d91f8b83743e81c9f41b8bfc04933c4dd11539476b20c11",
"md5": "8ec1a71c3cd1bb2c99b775fbb87f72c5",
"sha256": "3d6b5df273088f20aec03a16a4e35227c0537a4fe993d073fc4a26a98689745d"
},
"downloads": -1,
"filename": "riak-2.7.0-py3.4.egg",
"has_sig": false,
"md5_digest": "8ec1a71c3cd1bb2c99b775fbb87f72c5",
"packagetype": "bdist_egg",
"python_version": "3.4",
"requires_python": null,
"size": 463008,
"upload_time": "2016-12-12T22:51:33",
"upload_time_iso_8601": "2016-12-12T22:51:33.041189Z",
"url": "https://files.pythonhosted.org/packages/50/7b/4dfae10b1f091d91f8b83743e81c9f41b8bfc04933c4dd11539476b20c11/riak-2.7.0-py3.4.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "737ee5efbfd28e4b168c6fe2cf9aa34eca6c3343e6afb340edea865fded68ef9",
"md5": "d1bf90fa3d085ca3ed678c8762941bb2",
"sha256": "13b9bd65ce0f5a87ea0956ebec434848caf9c2b819db5500360601b69866b861"
},
"downloads": -1,
"filename": "riak-2.7.0-py3.5.egg",
"has_sig": false,
"md5_digest": "d1bf90fa3d085ca3ed678c8762941bb2",
"packagetype": "bdist_egg",
"python_version": "3.5",
"requires_python": null,
"size": 462211,
"upload_time": "2016-12-12T22:51:36",
"upload_time_iso_8601": "2016-12-12T22:51:36.937693Z",
"url": "https://files.pythonhosted.org/packages/73/7e/e5efbfd28e4b168c6fe2cf9aa34eca6c3343e6afb340edea865fded68ef9/riak-2.7.0-py3.5.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85f51a571ddc68f1dc7148f083f25210b7c7de8a9bc69d0ea5683ca6f3c189a9",
"md5": "84ab9c2c4cdefef0c01ca90c5071b881",
"sha256": "1c676b90fef357f60adc135ccd180ac28945b61b1367198a2a63df86e9bac1ca"
},
"downloads": -1,
"filename": "riak-2.7.0.tar.gz",
"has_sig": false,
"md5_digest": "84ab9c2c4cdefef0c01ca90c5071b881",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 194141,
"upload_time": "2016-12-12T22:51:18",
"upload_time_iso_8601": "2016-12-12T22:51:18.011569Z",
"url": "https://files.pythonhosted.org/packages/85/f5/1a571ddc68f1dc7148f083f25210b7c7de8a9bc69d0ea5683ca6f3c189a9/riak-2.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-12-12 22:51:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "basho",
"github_project": "riak-python-client",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "riak"
}
JSON
