Metadata-Version: 2.4
Name: rocksdb-ng
Version: 2.2.0
Summary: Python bindings for RocksDB
Home-page: https://github.com/f321x/python-rocksdb
Author: f321x
Author-email: f@f321x.com
License: BSD 3-Clause License
Project-URL: Bug Reports, https://github.com/f321x/python-rocksdb/issues
Project-URL: Repository, https://github.com/f321x/python-rocksdb
Keywords: rocksdb bindings
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Database
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: doc
Requires-Dist: sphinx<10,>=7.2; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"
Dynamic: license-file

python-rocksdb
==============

Python bindings for RocksDB.

See https://f321x.github.io/python-rocksdb/ for a more comprehensive install
and usage description.


Quick install
-------------

.. code-block:: bash

    $ pip install rocksdb-ng

The distribution is published to PyPI as ``rocksdb-ng`` (the plain ``rocksdb``
name belongs to the upstream project this is forked from). The import name is
unchanged -- after installing you still ``import rocksdb``. Because it ships the
same top-level ``rocksdb`` package, it cannot be co-installed with the original
``rocksdb`` distribution; uninstall that first (``pip uninstall rocksdb``).


Quick usage guide
-----------------

.. code-block:: python

    >>> 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'


Acknowledgements
----------------

This project attempts to collect the efforts put into different forks of the
`pyrocksdb`_ project that was originally written by `stephan-hof`_, as sadly
none seems to be actively maintained. In particular, the `python-rocksdb`_ fork
created by `twmht`_, but it also incorporates changes from other forks and
unfinished pull requests.

.. _python-rocksdb: https://github.com/twmht/python-rocksdb
.. _twmht: https://github.com/twmht
.. _pyrocksdb: https://github.com/stephan-hof/pyrocksdb
.. _stephan-hof: https://github.com/stephan-hof
.. _NightTsarina: https://github.com/NightTsarina


Disclaimer
----------
This python-rocksdb fork was developed mostly using LLM coding agents.
