Metadata-Version: 2.4
Name: fractal-converters-tools
Version: 0.6.1
Summary: Tooling to build ome-zarr HCS plate converters
Project-URL: homepage, https://github.com/fractal-analytics-platform/fractal-converters-tools
Project-URL: repository, https://github.com/fractal-analytics-platform/fractal-converters-tools
Author-email: Lorenzo Cerrone <lorenzo.cerrone@uzh.ch>
License: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: <3.14,>=3.11
Requires-Dist: ngio<0.4.0,>=0.3.2
Requires-Dist: numpy
Requires-Dist: tqdm
Requires-Dist: zarr
Provides-Extra: dev
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: notebook; extra == 'dev'
Requires-Dist: pdbpp; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: rich; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: markdown-exec[ansi]; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: mike; extra == 'docs'
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-autorefs; extra == 'docs'
Requires-Dist: mkdocs-git-committers-plugin-2; extra == 'docs'
Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'docs'
Requires-Dist: mkdocs-jupyter; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Requires-Dist: rich; extra == 'docs'
Requires-Dist: scikit-image; extra == 'docs'
Requires-Dist: tabulate; extra == 'docs'
Provides-Extra: test
Requires-Dist: devtools; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# fractal-converters-tools

[![License](https://img.shields.io/pypi/l/fractal-converters-tools.svg?color=green)](https://github.com/fractal-analytics-platform/fractal-converters-tools/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/fractal-converters-tools.svg?color=green)](https://pypi.org/project/fractal-converters-tools)
[![Python Version](https://img.shields.io/pypi/pyversions/fractal-converters-tools.svg?color=green)](https://python.org)
[![CI](https://github.com/fractal-analytics-platform/fractal-converters-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/fractal-analytics-platform/fractal-converters-tools/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/fractal-analytics-platform/fractal-converters-tools/branch/main/graph/badge.svg)](https://codecov.io/gh/fractal-analytics-platform/fractal-converters-tools)

Fractal Converters Tools is a Python package that provides tooling for building OME-Zarr converters for the Fractal platform.

It includes three main components:

1. Abstraction layer for mapping the on-disk raw data to an Image object
2. Common tooling to build converters as Fractal Compound Tasks

## Getting Started

To get started with Fractal Converters Tools, you can install it via pip:

```bash
pip install fractal-converters-tools
```

## Documentation

For detailed documentation on how to use Fractal Converters Tools, please refer to the [official documentation](https://fractal-analytics-platform.github.io/fractal-converters-tools/).

We also provide a minimal step-by-step guide to how to create a converter. You can find it in the [tutorial](https://fractal-analytics-platform.github.io/fractal-converters-tools/stable/tutorial/) section of the documentation.
