# 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-badge]][pypi-link] [![PyPI pyversions][pypi-pyversions]][pypi-link] |
| Build status | [![Build Status][build-badge]][build-link] [![Coverage Status][codecov-badge]][codecov-link] |
| Getting help | [![Docs status][rtd-badge]][rtd-link] |
| Performance | [Benchmarks][bench-link] |
## 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](http://www.aiida.net) (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](https://disk-objectstore.readthedocs.io/).
[bench-link]: https://aiidateam.github.io/disk-objectstore/dev/bench/
[build-badge]: https://github.com/aiidateam/disk-objectstore/workflows/Continuous%20integration/badge.svg
[build-link]: https://github.com/aiidateam/disk-objectstore/actions
[codecov-badge]: https://codecov.io/gh/aiidateam/disk-objectstore/branch/main/graph/badge.svg
[codecov-link]: https://codecov.io/gh/aiidateam/disk-objectstore
[pypi-badge]: https://badge.fury.io/py/disk-objectstore.svg
[pypi-link]: https://pypi.python.org/pypi/disk-objectstore
[pypi-pyversions]: https://img.shields.io/badge/Supported%20platforms-windows%20%7c%20macos%20%7c%20linux-1f425f.svg
[rtd-badge]: https://readthedocs.org/projects/disk-objectstore/badge
[rtd-link]: http://disk-objectstore.readthedocs.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "disk_objectstore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "object store,repository,file store,key-value store",
"author": "Giovanni Pizzi, Chris Sewell, Sebastiaan P. Huber",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/26/d5/f608e06db76b325a84c996b4883a510e3be4cf5636e9c7174c66fef8f31b/disk_objectstore-1.0.0.tar.gz",
"platform": null,
"description": "# disk-objectstore\n\nAn implementation of an efficient key-value store that writes directly on disk\nand does not require a server running.\n\n| | |\n| -------------- | -------------------------------------------------------------------------------------------- |\n| Latest release | [![PyPI version][pypi-badge]][pypi-link] [![PyPI pyversions][pypi-pyversions]][pypi-link] |\n| Build status | [![Build Status][build-badge]][build-link] [![Coverage Status][codecov-badge]][codecov-link] |\n| Getting help | [![Docs status][rtd-badge]][rtd-link] |\n| Performance | [Benchmarks][bench-link] |\n\n## Goal\n\nThe goal of this project is to have a very efficient implementation of an \"object store\"\nthat works directly on a disk folder, does not require a server to run, and addresses\na number of performance issues, discussed also below.\n\nThis project targets objects that range from very few bytes up to tens of GB each, with\nperformance tuned to support tens of millions of objects or more.\n\nThis project originated from the requirements needed by an efficient repository\nimplementation in [AiiDA](http://www.aiida.net) (note, however, that this\npackage is completely independent of AiiDA).\n\n## How to install\n\nTo install, just run:\n\n```\npip install disk-objectstore\n```\n\nThis will also install a simple `dostore` command line utility together with the library itself.\n\n## Documentation\n\nFor instructions on how to use it, some quick start guide, and more detailed information\non the design of the library and its performance, you can check [the documentation](https://disk-objectstore.readthedocs.io/).\n\n[bench-link]: https://aiidateam.github.io/disk-objectstore/dev/bench/\n[build-badge]: https://github.com/aiidateam/disk-objectstore/workflows/Continuous%20integration/badge.svg\n[build-link]: https://github.com/aiidateam/disk-objectstore/actions\n[codecov-badge]: https://codecov.io/gh/aiidateam/disk-objectstore/branch/main/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/aiidateam/disk-objectstore\n[pypi-badge]: https://badge.fury.io/py/disk-objectstore.svg\n[pypi-link]: https://pypi.python.org/pypi/disk-objectstore\n[pypi-pyversions]: https://img.shields.io/badge/Supported%20platforms-windows%20%7c%20macos%20%7c%20linux-1f425f.svg\n[rtd-badge]: https://readthedocs.org/projects/disk-objectstore/badge\n[rtd-link]: http://disk-objectstore.readthedocs.io/\n",
"bugtrack_url": null,
"license": null,
"summary": "An implementation of an efficient object store that writes directly on disk.",
"version": "1.0.0",
"project_urls": {
"Source": "https://github.com/aiidateam/disk-objectstore"
},
"split_keywords": [
"object store",
"repository",
"file store",
"key-value store"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d34d8b5081cbe8e256e50ce3c7fbb336137dc519120407a289e657252b969bda",
"md5": "04f12571c2736496285a4bbe1b8614f4",
"sha256": "4205d245c38af7da87883b651f0e783c25e577beaf5b13d367f3bc07771dd172"
},
"downloads": -1,
"filename": "disk_objectstore-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04f12571c2736496285a4bbe1b8614f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 65041,
"upload_time": "2023-10-09T09:12:34",
"upload_time_iso_8601": "2023-10-09T09:12:34.947483Z",
"url": "https://files.pythonhosted.org/packages/d3/4d/8b5081cbe8e256e50ce3c7fbb336137dc519120407a289e657252b969bda/disk_objectstore-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "26d5f608e06db76b325a84c996b4883a510e3be4cf5636e9c7174c66fef8f31b",
"md5": "02d056f1fad7748d9b727baa4dd0e243",
"sha256": "a61e3a817e2552fc834a61aaba975708ab1342b3bee4d3bdd6e3fc69de5177db"
},
"downloads": -1,
"filename": "disk_objectstore-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "02d056f1fad7748d9b727baa4dd0e243",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7326022,
"upload_time": "2023-10-09T09:12:37",
"upload_time_iso_8601": "2023-10-09T09:12:37.382118Z",
"url": "https://files.pythonhosted.org/packages/26/d5/f608e06db76b325a84c996b4883a510e3be4cf5636e9c7174c66fef8f31b/disk_objectstore-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-09 09:12:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aiidateam",
"github_project": "disk-objectstore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "disk_objectstore"
}
JSON
