Miette

Miette is a "small sweet thing" in French.

In another way, Miette is a light-weight, low-memory-usage library for reading Microsoft Office documents — starting with Word Binary Files (.doc).

Requires Python 3.8+ and the cfb library.

Usage

from miette import DocReader

doc = DocReader("document.doc")
print(doc.read())

Development

make install      # set up virtualenv + install dev dependencies
make format       # run black
make lint         # run ruff
make typecheck    # run mypy
make test         # run pytest with coverage
make tox          # run tests across Python 3.8, 3.10, and 3.12
make pre-commit   # install pre-commit hooks
make clean        # remove build artifacts and caches

Note: cfb is not yet on PyPI. The Makefile installs it from ../cfb. For CI, it is installed from GitHub.

License

BSD 2-Clause — see LICENSE.