|pypi| |docs| |coverage|
===========
ome-zarr-py
===========
Tools for multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.
See `Documentation <https://ome-zarr.readthedocs.io/>`_ for usage information.
Documentation
-------------
Documentation will be automatically built with `readthedocs`.
It can be built locally with::
$ pip install -r docs/requirements.txt
$ sphinx-build -b html docs/source/ docs/build/html
Tests
-----
Tests can be run locally via `tox` with::
$ pip install tox
$ tox
To enable pre-commit code validation::
$ pip install pre-commit
$ pre-commit install
Release process
---------------
This repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.
To tag a release run::
$ bumpversion release
This will remove the ``.dev0`` suffix from the current version, commit, and tag the release.
To switch back to a development version run::
$ bumpversion --no-tag [major|minor|patch]
specifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.
Remember to ``git push`` all commits and tags.
License
-------
Distributed under the terms of the `BSD`_ license,
"ome-zarr-py" is free and open source software
.. _`OME NGFF spec`: https://github.com/ome/ngff
.. _`@napari`: https://github.com/napari
.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`Mozilla Public License 2.0`: https://www.mozilla.org/media/MPL/2.0/index.txt
.. _`napari`: https://github.com/napari/napari
.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr
.. _`ome-zarr`: https://pypi.org/project/ome-zarr/
.. |pypi| image:: https://badge.fury.io/py/ome-zarr.svg
:alt: PyPI project
:target: https://badge.fury.io/py/ome-zarr
.. |docs| image:: https://readthedocs.org/projects/ome-zarr/badge/?version=stable
:alt: Documentation Status
:scale: 100%
:target: https://ome-zarr.readthedocs.io/en/stable/?badge=stable
.. |coverage| image:: https://codecov.io/gh/ome/ome-zarr-py/branch/master/graph/badge.svg
:alt: Test coverage
:scale: 100%
:target: https://codecov.io/gh/ome/ome-zarr-py
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/ome-zarr-py",
"name": "ome-zarr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "The Open Microscopy Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/93/62/52557b3647cc45ae5c21e7be28b898a8c2157998d13fb4de2e0afd055894/ome-zarr-0.9.0.tar.gz",
"platform": null,
"description": "|pypi| |docs| |coverage|\n\n===========\nome-zarr-py\n===========\n\nTools for multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.\n\nSee `Documentation <https://ome-zarr.readthedocs.io/>`_ for usage information.\n\nDocumentation\n-------------\n\nDocumentation will be automatically built with `readthedocs`.\n\nIt can be built locally with::\n\n $ pip install -r docs/requirements.txt\n $ sphinx-build -b html docs/source/ docs/build/html\n\nTests\n-----\n\nTests can be run locally via `tox` with::\n\n $ pip install tox\n $ tox\n\nTo enable pre-commit code validation::\n\n $ pip install pre-commit\n $ pre-commit install\n\nRelease process\n---------------\n\nThis repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.\nTo tag a release run::\n\n $ bumpversion release\n\nThis will remove the ``.dev0`` suffix from the current version, commit, and tag the release.\n\nTo switch back to a development version run::\n\n $ bumpversion --no-tag [major|minor|patch]\n\nspecifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.\n\nRemember to ``git push`` all commits and tags.\n\nLicense\n-------\n\nDistributed under the terms of the `BSD`_ license,\n\"ome-zarr-py\" is free and open source software\n\n.. _`OME NGFF spec`: https://github.com/ome/ngff\n.. _`@napari`: https://github.com/napari\n.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause\n.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0\n.. _`Mozilla Public License 2.0`: https://www.mozilla.org/media/MPL/2.0/index.txt\n.. _`napari`: https://github.com/napari/napari\n.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr\n.. _`ome-zarr`: https://pypi.org/project/ome-zarr/\n\n.. |pypi| image:: https://badge.fury.io/py/ome-zarr.svg\n :alt: PyPI project\n :target: https://badge.fury.io/py/ome-zarr\n\n.. |docs| image:: https://readthedocs.org/projects/ome-zarr/badge/?version=stable\n :alt: Documentation Status\n :scale: 100%\n :target: https://ome-zarr.readthedocs.io/en/stable/?badge=stable\n\n.. |coverage| image:: https://codecov.io/gh/ome/ome-zarr-py/branch/master/graph/badge.svg\n :alt: Test coverage\n :scale: 100%\n :target: https://codecov.io/gh/ome/ome-zarr-py\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Implementation of images in Zarr files.",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/ome/ome-zarr-py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4fb0e749e8d5346d12303bcbc24ba9b24f8bf39532da0c6d07f588b210343ac2",
"md5": "66ae9047c0798cfcaf7afe1d1543f1a9",
"sha256": "f8e0fc5ecb5ef8803615be22fb12906f2b9b937baccbee44a534cc1c426f9f97"
},
"downloads": -1,
"filename": "ome_zarr-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66ae9047c0798cfcaf7afe1d1543f1a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 37017,
"upload_time": "2024-05-22T09:15:24",
"upload_time_iso_8601": "2024-05-22T09:15:24.724641Z",
"url": "https://files.pythonhosted.org/packages/4f/b0/e749e8d5346d12303bcbc24ba9b24f8bf39532da0c6d07f588b210343ac2/ome_zarr-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "936252557b3647cc45ae5c21e7be28b898a8c2157998d13fb4de2e0afd055894",
"md5": "6887e84cd2077a1128e0382a8feb4235",
"sha256": "01392f1d1fc54d6b819a0125c99550c14ab89a24e1fccdfd58f09a2c4f2326dc"
},
"downloads": -1,
"filename": "ome-zarr-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "6887e84cd2077a1128e0382a8feb4235",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 33527,
"upload_time": "2024-05-22T09:15:33",
"upload_time_iso_8601": "2024-05-22T09:15:33.059072Z",
"url": "https://files.pythonhosted.org/packages/93/62/52557b3647cc45ae5c21e7be28b898a8c2157998d13fb4de2e0afd055894/ome-zarr-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 09:15:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "ome-zarr-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ome-zarr"
}
JSON
