# h5grove, core utilities to serve HDF5 file contents
**h5grove** is a Python package that provides utilities to design backends serving HDF5 file content: attributes, metadata and data. HDF5 files are accessed with [h5py](https://github.com/h5py/).
## Documentation
The documentation of the latest release is available [here](https://silx-kit.github.io/h5grove/).
## Rationale
There are several packages out there that can serve HDF5 files. However, they are dedicated to their usecases and settle on one implementation, hampering reusability.
In addition, some problems arise constantly when designing HDF5 backends. To name a few:
- Resolving external links
- Dealing with compression and slicing of datasets
- Encoding data efficiently and consistently (looking at you, `NaN`, `Infinity` in JSON)
**h5grove** aims at providing building blocks that solve these common problems and can be reused in existing or new backends.
## Installation
```bash
pip install h5grove
```
You can use **h5grove** low-level utilities whatever the backend implementation you choose. Additional utilities are provided for several Python web frameworks but require additional packages that can be installed the following way:
- [FastAPI](https://fastapi.tiangolo.com/)
```bash
pip install h5grove[fastapi]
```
- [Flask](https://flask.palletsprojects.com/en/)
```bash
pip install h5grove[flask]
```
- [Tornado](https://www.tornadoweb.org/en/stable/)
```bash
pip install h5grove[tornado]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/silx-kit/h5grove",
"name": "h5grove",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "European Synchrotron Radiation Facility",
"author_email": "h5web@esrf.fr",
"download_url": "https://files.pythonhosted.org/packages/2b/01/5ae387be04ac0b5a4397b1c3a186f4ba22711563c018392adfb6b7cdc070/h5grove-2.2.0.tar.gz",
"platform": null,
"description": "# h5grove, core utilities to serve HDF5 file contents\n\n**h5grove** is a Python package that provides utilities to design backends serving HDF5 file content: attributes, metadata and data. HDF5 files are accessed with [h5py](https://github.com/h5py/).\n\n## Documentation\n\nThe documentation of the latest release is available [here](https://silx-kit.github.io/h5grove/).\n\n## Rationale\n\nThere are several packages out there that can serve HDF5 files. However, they are dedicated to their usecases and settle on one implementation, hampering reusability.\n\nIn addition, some problems arise constantly when designing HDF5 backends. To name a few:\n\n- Resolving external links\n- Dealing with compression and slicing of datasets\n- Encoding data efficiently and consistently (looking at you, `NaN`, `Infinity` in JSON)\n\n**h5grove** aims at providing building blocks that solve these common problems and can be reused in existing or new backends.\n\n## Installation\n\n```bash\npip install h5grove\n```\n\nYou can use **h5grove** low-level utilities whatever the backend implementation you choose. Additional utilities are provided for several Python web frameworks but require additional packages that can be installed the following way:\n\n- [FastAPI](https://fastapi.tiangolo.com/)\n\n```bash\npip install h5grove[fastapi]\n```\n\n- [Flask](https://flask.palletsprojects.com/en/)\n\n```bash\npip install h5grove[flask]\n```\n\n- [Tornado](https://www.tornadoweb.org/en/stable/)\n\n```bash\npip install h5grove[tornado]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core utilities to serve HDF5 file contents",
"version": "2.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/silx-kit/h5grove/-/issues",
"Homepage": "https://github.com/silx-kit/h5grove"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89fdb16702c8a60b422650eac911140a2ebbe7d2876f12cdb724e9b4d38b92db",
"md5": "be007141e796402005dd346413168ec8",
"sha256": "6320d688c0235edadf9116392491a476fd1a5363668110e85591870f6722bfcd"
},
"downloads": -1,
"filename": "h5grove-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be007141e796402005dd346413168ec8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16329,
"upload_time": "2024-04-23T12:51:48",
"upload_time_iso_8601": "2024-04-23T12:51:48.876686Z",
"url": "https://files.pythonhosted.org/packages/89/fd/b16702c8a60b422650eac911140a2ebbe7d2876f12cdb724e9b4d38b92db/h5grove-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b015ae387be04ac0b5a4397b1c3a186f4ba22711563c018392adfb6b7cdc070",
"md5": "a6de0d19563ca393e46568be19b35f7c",
"sha256": "4ff4aed7166931ed71466ebe6ef49871a8ae76d85e4084601362c8a2b7af0c5d"
},
"downloads": -1,
"filename": "h5grove-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a6de0d19563ca393e46568be19b35f7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16479,
"upload_time": "2024-04-23T12:51:51",
"upload_time_iso_8601": "2024-04-23T12:51:51.474014Z",
"url": "https://files.pythonhosted.org/packages/2b/01/5ae387be04ac0b5a4397b1c3a186f4ba22711563c018392adfb6b7cdc070/h5grove-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 12:51:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "silx-kit",
"github_project": "h5grove",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "h5grove"
}
JSON
