{ "info": { "author": "keyvaluehosting.com team", "author_email": "info@keyvaluehosting.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Database" ], "description": "Python Client for Riak\n======================\n\nBuild Status\n============\n\n[![Build Status](https://travis-ci.org/basho/riak-python-client.svg?branch=master)](https://travis-ci.org/basho/riak-python-client)\n\nDocumentation\n=============\n\n[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).\n\nDocumentation for Riak is available [here](http://docs.basho.com/riak/latest).\n\nRepository Cloning\n==================\n\n*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.\n\nInstall\n=======\n\nThe 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.\n\nRiak TS (Timeseries)\n===================\n\nYou 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).\n\nFrom Source\n-----------\n\n```sh\npython setup.py install\n```\n\nThere are additional dependencies on Python packages `setuptools` and `protobuf`.\n\nFrom PyPI\n---------\n\nOfficial packages are signed and published to [PyPI](https://pypi.python.org/pypi/riak).\n\nTo install from [PyPI](https://pypi.python.org/pypi/riak) directly you can use `pip`. \n\n```sh\npip install riak\n```\n\nTesting\n=======\n\nTo setup the default test configuration build a test Riak node (from a `riak` directory)\n\n```sh\nmake rel\n```\n\nSee [Basic Cluster Setup](http://docs.basho.com/riak/latest/ops/building/basic-cluster-setup/) for more details.\n\nFor all of the simple default values, set the `RIAK_DIR` environment variable to the root of your Riak installation. Then from the `riak-python-client` directory \n\n```sh\nmake -C buildbot preconfigure\n```\n\nStart your Riak node with `riak start` from the the Riak directory, then \n\n```sh\nmake -C buildbot configure\nmake -C buildbot test\n```\n\nThat will run the test suite twice: once with security enabled and once without.\n\nConnections to Riak in Tests\n----------------------------\n\nIf your Riak server isn't running on localhost or you have built a Riak devrel from source, use the environment variables `RIAK_TEST_HOST`, `RIAK_TEST_HTTP_PORT` and `RIAK_TEST_PB_PORT` to specify where to find the Riak server. `RIAK_TEST_PROTOCOL` to specify which protocol to test. Can be either `pbc` or `http`.\n\nSome of the connection tests need port numbers that are NOT in use. If ports 1023 and 1022 are in use on your test system, set the environment variables `DUMMY_HTTP_PORT` and `DUMMY_PB_PORT` to unused port numbers.\n\nTesting Search\n--------------\n\nIf you don't have [Riak Search](http://docs.basho.com/riak/latest/dev/using/search/) enabled, you can set the `RUN_SEARCH` environment variable to 0 skip those tests.\n\nIf you don't have [Search 2.0](https://github.com/basho/yokozuna) enabled, you can set the `RUN_YZ` environment variable to 0 to skip those tests.\n\nTesting Bucket Types (Riak 2+)\n------------------------------\n\nTo test bucket-types, you must run the `create_bucket_types` setup command, which will create the bucket-types used in testing, or create them manually yourself. It can be run like so (substituting `$RIAK` with the root of your Riak install)\n\n```sh\n./setup.py create_bucket_types --riak-admin=$RIAK/bin/riak-admin\n```\n\nYou may alternately add these lines to `setup.cfg`\n\n```ini\n[create_bucket_types]\nriak-admin=/Users/sean/dev/riak/rel/riak/bin/riak-admin\n```\n\nTo skip the bucket-type tests, set the `RUN_BTYPES` environment variable to `0`.\n\nTesting Data Types (Riak 2+)\n----------------------------\n\nTo test data types, you must set up bucket types (see above.)\n\nTo skip the data type tests, set the `RUN_DATATYPES` environment variable to `0`.\n\nTesting Timeseries (Riak 2.1+)\n------------------------------\n\nTo test timeseries data, you must run the `setup_timeseries` command, which will create the bucket-types used in testing, or create them manually yourself. It can be run like so (substituting `$RIAK` with the root of your Riak install)\n\n```sh\n./setup.py setup_timeseries --riak-admin=$RIAK/bin/riak-admin\n```\n\nYou may alternately add these lines to `setup.cfg`\n\n```sh\n[setup_timeseries]\nriak-admin=/Users/sean/dev/riak/rel/riak/bin/riak-admin\n```\n\nTo enable the timeseries tests, set the `RUN_TIMESERIES` environment variable to `1`.\n\nTesting Secondary Indexes\n-------------------------\n\nTo test [Secondary Indexes](http://docs.basho.com/riak/latest/dev/using/2i/), the `RUN_INDEXES` environment variable must be set to 1 (or 0 to skip them.)\n\nTesting Security (Riak 2+)\n--------------------------\n\nEnsure that the hostname `riak-test` resolves to your Riak host (most likely `localhost`). This is so the SSL host verification can succeed.\n\nBy default [Security](http://docs.basho.com/riak/latest/ops/running/authz/) is not enabled on Riak. Once `security = on` is configured in the `riak.conf` file it can be enabled with `riak-admin`.\n\nTo run the tests\n\n```sh\nRUN_SECURITY=1 RIAK_TEST_HTTP_PORT=18098 python setup.py test\n```\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* [Vitaly Shestovskiy](https://github.com/lamp0chka)\n* William Kral\n* [Yasser Souri](https://github.com/yassersouri)", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/shikolay/riak-python-client", "keywords": null, "license": "Apache 2", "maintainer": null, "maintainer_email": null, "name": "kvhosting", "package_url": "https://pypi.org/project/kvhosting/", "platform": "Platform Independent", "project_url": "https://pypi.org/project/kvhosting/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/shikolay/riak-python-client" }, "release_url": "https://pypi.org/project/kvhosting/1.0.4/", "requires_dist": null, "requires_python": null, "summary": "Python client for keyvaluehosting.com", "version": "1.0.4" }, "last_serial": 2417880, "releases": { "1.0.3": [ { "comment_text": "", "digests": { "md5": "71ef202307e4d63400928d4569e53aa2", "sha256": "741e4035109002ed4825a85a2d33ce41a6bd522a083a1e278c1d0b36ba2fb6d2" }, "downloads": -1, "filename": "kvhosting-1.0.3.tar.gz", "has_sig": false, "md5_digest": "71ef202307e4d63400928d4569e53aa2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 154354, "upload_time": "2016-10-21T03:57:46", "url": "https://files.pythonhosted.org/packages/61/74/618b871a39188a9a1a413f49af42fbd9fbcea43352f5dd962c2eace831e5/kvhosting-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "9b00525fec12dc34615b649652e1e45b", "sha256": "eec4e519494a0819bbcaf9ce044f2f31a64917e3e408785ee33b0c3e252ca752" }, "downloads": -1, "filename": "kvhosting-1.0.4.tar.gz", "has_sig": false, "md5_digest": "9b00525fec12dc34615b649652e1e45b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 154349, "upload_time": "2016-10-23T03:40:42", "url": "https://files.pythonhosted.org/packages/55/7a/406cb4f6d9c88bb209ea9f2c883e6ce9d3e6b783dc21d4f01d206b8c8206/kvhosting-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9b00525fec12dc34615b649652e1e45b", "sha256": "eec4e519494a0819bbcaf9ce044f2f31a64917e3e408785ee33b0c3e252ca752" }, "downloads": -1, "filename": "kvhosting-1.0.4.tar.gz", "has_sig": false, "md5_digest": "9b00525fec12dc34615b649652e1e45b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 154349, "upload_time": "2016-10-23T03:40:42", "url": "https://files.pythonhosted.org/packages/55/7a/406cb4f6d9c88bb209ea9f2c883e6ce9d3e6b783dc21d4f01d206b8c8206/kvhosting-1.0.4.tar.gz" } ] }