pydantic-zarr


Namepydantic-zarr JSON
Version 0.8.0 PyPI version JSON
download
home_pageNone
SummaryPydantic models for the Zarr file format
upload_time2025-07-31 09:33:43
maintainerDavid Stansby
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords pydantic zarr
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pydantic-zarr

[![PyPI](https://img.shields.io/pypi/v/pydantic-zarr)](https://pypi.python.org/pypi/pydantic-zarr)

[Pydantic](https://docs.pydantic.dev/latest/) models for [Zarr](https://zarr.readthedocs.io/en/stable/index.html).

## Installation

`pip install -U pydantic-zarr`

## Getting help

- Docs: see the [documentation](https://zarr.dev/pydantic-zarr/) for detailed information about this project.
- Chat: We use [Zulip](https://ossci.zulipchat.com/#narrow/channel/423692-Zarr) for project-related chat.

## Example

```python
import zarr
from pydantic_zarr import GroupSpec

group = zarr.group(path='foo')
array = zarr.create(store = group.store, path='foo/bar', shape=10, dtype='uint8')
array.attrs.put({'metadata': 'hello'})

# this is a pydantic model
spec = GroupSpec.from_zarr(group)
print(spec.model_dump())
"""
{
    'zarr_format': 2,
    'attributes': {},
    'members': {
        'bar': {
            'zarr_format': 2,
            'attributes': {'metadata': 'hello'},
            'shape': (10,),
            'chunks': (10,),
            'dtype': '|u1',
            'fill_value': 0,
            'order': 'C',
            'filters': None,
            'dimension_separator': '.',
            'compressor': {
                'id': 'blosc',
                'cname': 'lz4',
                'clevel': 5,
                'shuffle': 1,
                'blocksize': 0,
            },
        }
    },
}
"""
```

## History

This project was developed at [HHMI / Janelia Research Campus](https://www.janelia.org/). It was originally written by Davis Bennett to solve problems he encountered while working on the [Cellmap Project team](https://www.janelia.org/project-team/cellmap/members). In December of 2024 this project was migrated from the [`janelia-cellmap`](https://github.com/janelia-cellmap) github organization to [`zarr-developers`](https://github.com/zarr-developers) organization.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pydantic-zarr",
    "maintainer": "David Stansby",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "pydantic, zarr",
    "author": null,
    "author_email": "Davis Bennett <davis.v.bennett@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/50/35/286fb87c2f8762916da0477ce70859f69862058f5602213743f8a752445d/pydantic_zarr-0.8.0.tar.gz",
    "platform": null,
    "description": "# pydantic-zarr\n\n[![PyPI](https://img.shields.io/pypi/v/pydantic-zarr)](https://pypi.python.org/pypi/pydantic-zarr)\n\n[Pydantic](https://docs.pydantic.dev/latest/) models for [Zarr](https://zarr.readthedocs.io/en/stable/index.html).\n\n## Installation\n\n`pip install -U pydantic-zarr`\n\n## Getting help\n\n- Docs: see the [documentation](https://zarr.dev/pydantic-zarr/) for detailed information about this project.\n- Chat: We use [Zulip](https://ossci.zulipchat.com/#narrow/channel/423692-Zarr) for project-related chat.\n\n## Example\n\n```python\nimport zarr\nfrom pydantic_zarr import GroupSpec\n\ngroup = zarr.group(path='foo')\narray = zarr.create(store = group.store, path='foo/bar', shape=10, dtype='uint8')\narray.attrs.put({'metadata': 'hello'})\n\n# this is a pydantic model\nspec = GroupSpec.from_zarr(group)\nprint(spec.model_dump())\n\"\"\"\n{\n    'zarr_format': 2,\n    'attributes': {},\n    'members': {\n        'bar': {\n            'zarr_format': 2,\n            'attributes': {'metadata': 'hello'},\n            'shape': (10,),\n            'chunks': (10,),\n            'dtype': '|u1',\n            'fill_value': 0,\n            'order': 'C',\n            'filters': None,\n            'dimension_separator': '.',\n            'compressor': {\n                'id': 'blosc',\n                'cname': 'lz4',\n                'clevel': 5,\n                'shuffle': 1,\n                'blocksize': 0,\n            },\n        }\n    },\n}\n\"\"\"\n```\n\n## History\n\nThis project was developed at [HHMI / Janelia Research Campus](https://www.janelia.org/). It was originally written by Davis Bennett to solve problems he encountered while working on the [Cellmap Project team](https://www.janelia.org/project-team/cellmap/members). In December of 2024 this project was migrated from the [`janelia-cellmap`](https://github.com/janelia-cellmap) github organization to [`zarr-developers`](https://github.com/zarr-developers) organization.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Pydantic models for the Zarr file format",
    "version": "0.8.0",
    "project_urls": {
        "Documentation": "https://zarr.dev/pydantic-zarr/",
        "Issues": "https://github.com/zarr-developers/pydantic-zarr/issues",
        "Source": "https://github.com/zarr-developers/pydantic-zarr"
    },
    "split_keywords": [
        "pydantic",
        " zarr"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f46dd6cf0d66f5cca0f86f60dc4e8b114f7e638727b4ba09bfd04e449401ad0f",
                "md5": "8f0aeb4ea852a9fefc1990cb43ad8494",
                "sha256": "e7dd71faca2c2c79a1e9685c945d8b0e2f29839a3456a961d7aebdd3a86fdff0"
            },
            "downloads": -1,
            "filename": "pydantic_zarr-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8f0aeb4ea852a9fefc1990cb43ad8494",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 25397,
            "upload_time": "2025-07-31T09:33:42",
            "upload_time_iso_8601": "2025-07-31T09:33:42.759659Z",
            "url": "https://files.pythonhosted.org/packages/f4/6d/d6cf0d66f5cca0f86f60dc4e8b114f7e638727b4ba09bfd04e449401ad0f/pydantic_zarr-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5035286fb87c2f8762916da0477ce70859f69862058f5602213743f8a752445d",
                "md5": "ea794982f985a5d288bb2aa98491b16f",
                "sha256": "63103c341e260cfafcd606a394286b196271459054508d6160ec7bc0493eb197"
            },
            "downloads": -1,
            "filename": "pydantic_zarr-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ea794982f985a5d288bb2aa98491b16f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 43652,
            "upload_time": "2025-07-31T09:33:43",
            "upload_time_iso_8601": "2025-07-31T09:33:43.924232Z",
            "url": "https://files.pythonhosted.org/packages/50/35/286fb87c2f8762916da0477ce70859f69862058f5602213743f8a752445d/pydantic_zarr-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-31 09:33:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zarr-developers",
    "github_project": "pydantic-zarr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pydantic-zarr"
}
        
Elapsed time: 1.13815s