e4c0de9455
This change:
* uses to setuptools Cython automatic extension build system.
* Add tox.ini to run tests and build docs into virtualenv
* Add .travis.yaml and Dockerfile to run tests in CI
* Change requirements to ensure:
- Cython and setuptools are installed before we build the Cython
extension
- tests dependencies are not installed by default
- doc dependencies are explicit
* Add missing lz4 library
* Allow to build the module with any librocksdb headers (no-rtti)
Closes #15
42 lines
962 B
ReStructuredText
42 lines
962 B
ReStructuredText
Welcome to python-rocksdb's documentation!
|
|
==========================================
|
|
|
|
Overview
|
|
--------
|
|
Python bindings to the C++ interface of http://rocksdb.org/ using cython::
|
|
|
|
import rocksdb
|
|
db = rocksdb.DB("test.db", rocksdb.Options(create_if_missing=True))
|
|
db.put(b"a", b"b")
|
|
print db.get(b"a")
|
|
|
|
|
|
Tested with python2.7 and python3.4 and RocksDB version 5.3.0
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Instructions how to install <installation>
|
|
Tutorial <tutorial/index>
|
|
API <api/index>
|
|
Changelog <changelog>
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
Source can be found on `github <https://github.com/stephan-hof/pyrocksdb>`_.
|
|
Feel free to fork and send pull-requests or create issues on the
|
|
`github issue tracker <https://github.com/stephan-hof/pyrocksdb/issues>`_
|
|
|
|
RoadMap/TODO
|
|
------------
|
|
|
|
No plans so far. Please submit wishes to the github issues.
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|