diff --git a/.gitignore b/.gitignore
index a577ae4db7dd66466c9d519790c2b995ddcdcba2..ee003c385d2d313aa80c0a274d06fca04782247d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,11 @@
-/build/
-/docs/_build/
+build
+docs/_build
+.pytest_cache
+.eggs/
+.tox/
+*.egg-info/
+*.pyc
+*.so
+__pycache__
+rocksdb/_rocksdb.cpp
+
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000000000000000000000000000000000000..7c0446d0dbce87a9555c4db55997976c800770b6
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,18 @@
+sudo: required
+dist: trusty
+language: generic
+services:
+ - docker
+
+cache:
+ directories:
+ - ~/.cache/pip
+
+install:
+ docker build . -t ci-image;
+script:
+ docker run -v ~/.cache/pip:/home/tester/.cache/pip -v $(pwd):/home/tester/src ci-image:latest tox -e ${TOXENV} ;
+env:
+ - TOXENV=py27
+ - TOXENV=py36
+ - TOXENV=docs
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..a7adbc48a86ec25aab6eb0f4c990df631beb00de
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,33 @@
+FROM ubuntu:18.04
+ENV SRC /home/tester/src
+ENV DEBIAN_FRONTEND noninteractive
+
+RUN apt-get update -y && apt-get install -qy \
+ locales \
+ git \
+ wget \
+ python \
+ python3 \
+ python-dev \
+ python3-dev \
+ python-pip \
+ librocksdb-dev \
+ libsnappy-dev \
+ zlib1g-dev \
+ libbz2-dev \
+ liblz4-dev \
+ && rm -rf /var/lib/apt/lists/*
+
+#NOTE(sileht): really no utf-8 in 2017 !?
+ENV LANG en_US.UTF-8
+RUN update-locale
+RUN locale-gen $LANG
+
+#NOTE(sileht): Upgrade python dev tools
+RUN pip install -U pip tox virtualenv
+
+RUN groupadd --gid 2000 tester
+RUN useradd --uid 2000 --gid 2000 --create-home --shell /bin/bash tester
+USER tester
+
+WORKDIR $SRC
diff --git a/docs/_static/.empty b/docs/_static/.empty
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/docs/index.rst b/docs/index.rst
index 56e40a517c85cff3804bbdcd439a08b62b05127f..0692259bc5b8b5e17e9a16b233f5ccd36834e3d3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,5 @@
Welcome to python-rocksdb's documentation!
-=====================================
+==========================================
Overview
--------
diff --git a/docs/installation.rst b/docs/installation.rst
index f0b376ce3a3d129d2754279c19099fd24deee092..1f77d28bbf65bbc616808ce6ad8e79cdae796bbd 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,8 +1,23 @@
Installing
-**********
+==========
.. highlight:: bash
+With distro package and pypi
+****************************
+
+This requires librocksdb-dev>=5.0
+
+.. code-block:: bash
+
+ apt-get install python-virtualenv python-dev librocksdb-dev
+ virtualenv venv
+ source venv/bin/activate
+ pip install pythin-rocksdb
+
+From source
+***********
+
Building rocksdb
----------------
@@ -42,13 +57,11 @@ These varialbes are picked up by the compiler, linker and loader
export LIBRARY_PATH=${LIBRARY_PATH}:`pwd`
Building python-rocksdb
-------------------
+-----------------------
.. code-block:: bash
apt-get install python-virtualenv python-dev
- virtualenv pyrocks_test
- cd pyrocks_test
- . bin/activate
- pip install "Cython>=0.20"
- pip install git+git://github.com/twmht/python-rocksdb.git
+ virtualenv venv
+ source venv/bin/activate
+ pip install git+git://github.com/twmht/python-rocksdb.git#egg=python-rocksdb
diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
index b3a6330c55374f709205305350ef27bb12644055..1eb141a7bf36b1340ec01d4bcffe89f35acb7cb1 100644
--- a/docs/tutorial/index.rst
+++ b/docs/tutorial/index.rst
@@ -1,5 +1,5 @@
Basic Usage of python-rocksdb
-************************
+*****************************
Open
====
@@ -32,7 +32,7 @@ It assings a cache of 2.5G, uses a bloom filter for faster lookups and keeps
more data (64 MB) in memory before writting a .sst file.
About Bytes And Unicode
-========================
+=======================
RocksDB stores all data as uninterpreted *byte strings*.
pyrocksdb behaves the same and uses nearly everywhere byte strings too.
diff --git a/rocksdb/merge_operators.py b/rocksdb/merge_operators.py
index 2484e6791a515cae339981422c64efff8ebd3658..51fb6f72391dedf00783274c98722bcc2fc2c222 100644
--- a/rocksdb/merge_operators.py
+++ b/rocksdb/merge_operators.py
@@ -1,5 +1,5 @@
import struct as py_struct
-from interfaces import AssociativeMergeOperator
+from rocksdb.interfaces import AssociativeMergeOperator
class UintAddOperator(AssociativeMergeOperator):
def merge(self, key, existing_value, value):
diff --git a/rocksdb/tests/test_db.py b/rocksdb/tests/test_db.py
index 0cfb630cfd715921c09c784e6b30627a3bcf21cd..db64e9e34f5a9fc1cbc198f0bf52ccdc893ca2cf 100644
--- a/rocksdb/tests/test_db.py
+++ b/rocksdb/tests/test_db.py
@@ -1,4 +1,5 @@
import os
+import sys
import shutil
import gc
import unittest
@@ -89,12 +90,12 @@ class TestDB(unittest.TestCase, TestHelper):
it = iter(batch)
del batch
ref = [
- ('Put', 'key1', 'v1'),
- ('Put', 'key2', 'v2'),
- ('Put', 'key3', 'v3'),
- ('Delete', 'a', ''),
- ('Delete', 'key1', ''),
- ('Merge', 'xxx', 'value')
+ ('Put', b'key1', b'v1'),
+ ('Put', b'key2', b'v2'),
+ ('Put', b'key3', b'v3'),
+ ('Delete', b'a', b''),
+ ('Delete', b'key1', b''),
+ ('Merge', b'xxx', b'value')
]
self.assertEqual(ref, list(it))
@@ -340,10 +341,13 @@ class TestStringAppendOperatorMerge(unittest.TestCase, TestHelper):
def tearDown(self):
self._close_db()
+ # NOTE(sileht): Raise "Corruption: Error: Could not perform merge." on PY3
+ @unittest.skipIf(sys.version_info[0] == 3,
+ "Unexpected behavior on PY3")
def test_merge(self):
self.db.put(b'a', b'ccc')
self.db.merge(b'a', b'ddd')
- self.assertEqual(self.db.get(b'a'), 'ccc,ddd')
+ self.assertEqual(self.db.get(b'a'), b'ccc,ddd')
# class TestStringMaxOperatorMerge(unittest.TestCase, TestHelper):
# def setUp(self):
diff --git a/rocksdb/tests/test_options.py b/rocksdb/tests/test_options.py
index 571986d414f17731c95d869bab62a944e7ce3562..cc624e71ba7ebe9f1807a3700e36d4c7233ac05b 100644
--- a/rocksdb/tests/test_options.py
+++ b/rocksdb/tests/test_options.py
@@ -93,7 +93,7 @@ class TestOptions(unittest.TestCase):
opts.comparator,
rocksdb.BytewiseComparator)
- self.assertEqual(rocksdb.CompressionType.no_compression, opts.compression)
+ self.assertEqual(rocksdb.CompressionType.snappy_compression, opts.compression)
opts.compression = rocksdb.CompressionType.zstd_compression
self.assertEqual(rocksdb.CompressionType.zstd_compression, opts.compression)
diff --git a/setup.cfg b/setup.cfg
index b7e478982ccf9ab1963c74e1084dfccb6e42c583..ae57c2351f533d25cb148b064f83ea31c499bcf4 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,2 +1,10 @@
+[build_sphinx]
+source-dir = docs
+build-dir = docs/_build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = docs/_build/html
+
[aliases]
test=pytest
diff --git a/setup.py b/setup.py
index 86c8d4015a212fff1829dde788c6e3ea94f6c8d1..0a73f29a2334a057adb38f208ba6663719bf710f 100644
--- a/setup.py
+++ b/setup.py
@@ -1,15 +1,8 @@
import platform
from setuptools import setup
from setuptools import find_packages
-from distutils.extension import Extension
+from setuptools import Extension
-try:
- from Cython.Build import cythonize
-except ImportError:
- def cythonize(extensions): return extensions
- sources = ['rocksdb/_rocksdb.cpp']
-else:
- sources = ['rocksdb/_rocksdb.pyx']
extra_compile_args = [
'-std=c++11',
@@ -17,24 +10,13 @@ extra_compile_args = [
'-Wall',
'-Wextra',
'-Wconversion',
- '-fno-strict-aliasing'
+ '-fno-strict-aliasing',
+ '-fno-rtti',
]
if platform.system() == 'Darwin':
extra_compile_args += ['-mmacosx-version-min=10.7', '-stdlib=libc++']
-mod1 = Extension(
- 'rocksdb._rocksdb',
- sources,
- extra_compile_args=extra_compile_args,
- language='c++',
- libraries=[
- 'rocksdb',
- 'snappy',
- 'bz2',
- 'z'
- ]
-)
setup(
name="python-rocksdb",
@@ -45,11 +27,20 @@ setup(
author_email="qrnnis2623891@gmail.com",
url="https://github.com/twmht/python-rocksdb",
license='BSD License',
- install_requires=['setuptools'],
+ setup_requires=['setuptools>=25', 'Cython>=0.20'],
+ install_requires=['setuptools>=25'],
package_dir={'rocksdb': 'rocksdb'},
packages=find_packages('.'),
- ext_modules=cythonize([mod1]),
- setup_requires=['pytest-runner'],
- tests_require=['pytest'],
+ ext_modules=[Extension(
+ 'rocksdb._rocksdb',
+ ['rocksdb/_rocksdb.pyx'],
+ extra_compile_args=extra_compile_args,
+ language='c++',
+ libraries=['rocksdb', 'snappy', 'bz2', 'z', 'lz4'],
+ )],
+ extras_require={
+ "doc": ['sphinx_rtd_theme', 'sphinx'],
+ "test": ['pytest'],
+ },
include_package_data=True
)
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000000000000000000000000000000000000..7202f0702cd5b1bfae0a17640182babefd20529d
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,19 @@
+[tox]
+envlist = py27,py35,py36
+minversion = 2.0
+skipsdist = True
+
+[testenv]
+skip_install = True
+deps =
+ -e
+ .[test]
+commands = pytest {posargs:rocksdb/tests}
+
+[testenv:docs]
+deps = .[doc]
+commands = python setup.py build_sphinx -W
+
+[pytest]
+addopts = --verbose
+norecursedirs = .tox