aboutsummaryrefslogtreecommitdiffstats
path: root/bsie/reader/__init__.py
blob: 4163d1c33304e476c72913efdfaaec0847543ca7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
"""The Reader classes return high-level content structures from files.

The Reader fulfills two purposes:
    First, it brokers between multiple libraries and file formats.
    Second, it separates multiple aspects of a file into distinct content types.

Often, different libraries focus on reading different types of content from a
file. E.g. one would use different modules to read file system infos than to
read exif or pixel data of an image. Hence, this module is organized by content
type. Each distinct type can be implemented in a file or submodule that
provides a Reader implementation. Through utilization of submodules, different
file formats can be supported.

Part of the bsie module.
A copy of the license is provided with the project.
Author: Matthias Baumgartner, 2022
"""
# standard imports
import typing

# inner-module imports
from .base import Reader
from .builder import ReaderBuilder

# exports
__all__: typing.Sequence[str] = (
    'Reader',
    'ReaderBuilder',
    )

## EOF ##
## EOF ##