Python bindings for RocksDB
Find a file
2015-08-30 12:20:45 +02:00
docs Change API of compact_range to be compatible with the change of rocksdb. 2015-08-27 21:45:09 +02:00
rocksdb No need for the 'get_ob' methods on PyCache. 2015-08-30 12:20:45 +02:00
.gitignore Add makefile for docs 2014-01-15 09:16:38 +01:00
LICENSE.md Create LICENSE.md 2014-02-02 17:39:01 +01:00
MANIFEST.in Add the .hpp .pxd .pyx files for the sdist. 2015-08-16 12:18:28 +02:00
README.rst Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00
setup.py Only 'cythonize' if Cython is installed. 2015-08-16 12:17:47 +02:00

pyrocksdb
=========

Python bindings for RocksDB.
See http://pyrocksdb.readthedocs.org for a more comprehensive install and usage description.


Quick Install
-------------

Quick install for debian/ubuntu like linux distributions.

.. code-block:: bash

    $ apt-get install build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev
    $ git clone https://github.com/facebook/rocksdb.git
    $ cd rocksdb
    $ make shared_lib
    $ export CPLUS_INCLUDE_PATH=${CPLUS_INCLUDE_PATH}:`pwd`/include
    $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:`pwd`
    $ export LIBRARY_PATH=${LIBRARY_PATH}:`pwd`

    $ cd ../
    $ apt-get install python-virtualenv python-dev
    $ virtualenv pyrocks_test
    $ cd pyrocks_test
    $ . bin/active
    $ pip install pyrocksdb


Quick Usage Guide
-----------------

.. code-block:: pycon

    >>> import rocksdb
    >>> db = rocksdb.DB("test.db", rocksdb.Options(create_if_missing=True))
    >>> db.put(b'a', b'data')
    >>> print db.get(b'a')
    b'data'