Metadata-Version: 2.1
Name: bioio-base
Version: 0.1.0
Summary: Typing, base classes, and more for BioIO projects.
Author-email: Eva Maxfield Brown <evamaxfieldbrown@gmail.com>, Dan Toloudis <danielt@alleninstitute.org>
License: BSD License
Project-URL: Homepage, https://github.com/bioio-devs/bioio-base
Project-URL: Bug Tracker, https://github.com/bioio-devs/bioio-base/issues
Project-URL: Documentation, https://bioio-devs.github.io/bioio-base
Project-URL: User Support, https://github.com/bioio-devs/bioio-base/issues
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dask (!=2022.5.1,>=2021.4.1)
Requires-Dist: fsspec (!=2022.7.0,>=2021.4.0)
Requires-Dist: numpy (~=1.16)
Requires-Dist: ome-types (>=0.2)
Requires-Dist: xarray (>=2022.6.0)
Provides-Extra: dev
Requires-Dist: ipython (>=8.4.0) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: m2r2 (>=0.2.7) ; extra == 'docs'
Requires-Dist: Sphinx (>=4.0.0) ; extra == 'docs'
Requires-Dist: furo (>=2022.4.7) ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: docutils (<0.19,>=0.18) ; extra == 'docs'
Provides-Extra: lint
Requires-Dist: pre-commit (>=2.20.0) ; extra == 'lint'
Provides-Extra: test
Requires-Dist: coverage (>=5.1) ; extra == 'test'
Requires-Dist: pytest (>=5.4.3) ; extra == 'test'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'test'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'test'

# bioio-base

[![Build Status](https://github.com/bioio-devs/bioio-base/workflows/CI/badge.svg)](https://github.com/bioio-devs/bioio-base/actions)
[![Documentation](https://github.com/bioio-devs/bioio-base/workflows/Documentation/badge.svg)](https://bioio-devs.github.io/bioio-base)

Typing, base classes, and more for BioIO projects.

---

## Installation

**Stable Release:** `pip install bioio-base`<br>
**Development Head:** `pip install git+https://github.com/bioio-devs/bioio-base.git`

## Quickstart

```python
from bioio_base.reader import Reader

class CustomTiffReader(Reader):
    # Your code here
```

```python
from typing import List

from bioio_base.reader_metadata import ReaderMetadata as BaseReaderMetadata

class ReaderMetadata(BaseReaderMetadata):
    @staticmethod
    def get_supported_extensions() -> List[str]:
        return ["tif", "tiff"]

    @staticmethod
    def get_reader() -> bioio_base.reader.Reader:
        from .custom_tiff_reader import CustomTiffReader

        return CustomTiffReader
```

## Documentation

For full package documentation please visit [bioio-devs.github.io/bioio-base](https://bioio-devs.github.io/bioio-base).

## Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.

**BSD License**
