Metadata-Version: 2.4
Name: miette
Version: 2.0.2
Summary: Miette is a light-weight Microsoft Office documents reader
Author-email: Alex Rembish <alex@rembish.org>
License-Expression: BSD-2-Clause
Project-URL: Homepage, https://github.com/rembish/Miette
Project-URL: Repository, https://github.com/rembish/Miette
Project-URL: Changelog, https://github.com/rembish/Miette/blob/master/CHANGELOG.md
Project-URL: Issues, https://github.com/rembish/Miette/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cfb>=0.9.3
Requires-Dist: typing_extensions
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black>=24; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Requires-Dist: pre-commit>=3; extra == "dev"
Requires-Dist: tox>=4; extra == "dev"
Dynamic: license-file

# 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](https://github.com/rembish/cfb) library.

## Usage

```python
from miette import DocReader

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

## Development

```bash
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
```

## License

BSD 2-Clause — see [LICENSE](LICENSE).
