/disk-objectstore

An implementation of an efficient "object store" (actually, a key-value store) writing files on disk and not requiring a running server

Primary LanguagePythonMIT LicenseMIT

disk-objectstore

An implementation of an efficient key-value store that writes directly on disk and does not require a server running.

Latest release PyPI version PyPI pyversions
Build status Build Status Coverage Status
Getting help Docs status
Performance Benchmarks

Goal

The goal of this project is to have a very efficient implementation of an "object store" that works directly on a disk folder, does not require a server to run, and addresses a number of performance issues, discussed also below.

This project targets objects that range from very few bytes up to tens of GB each, with performance tuned to support tens of millions of objects or more.

This project originated from the requirements needed by an efficient repository implementation in AiiDA (note, however, that this package is completely independent of AiiDA).

How to install

To install, just run:

pip install disk-objectstore

This will also install a simple dostore command line utility together with the library itself.

Documentation

For instructions on how to use it, some quick start guide, and more detailed information on the design of the library and its performance, you can check the documentation.