diff --git a/README.rst b/README.rst index 1050f34e7f28f9c145ff01d544631094afcab880..55b47488b14a277dfafe4e6c2aec427c664a285a 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,40 @@ pyrocksdb ========= -Python bindings for RocksDB. See http://pyrocksdb.readthedocs.org for details +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'