Metadata-Version: 2.4
Name: epub-utils
Version: 0.0.0a3
Summary: A Python CLI and utility library for manipulating EPUB files
Home-page: https://github.com/ernestofgonzalez/epub-utils
Author: Ernesto González
License: Apache License, Version 2.0
Project-URL: Source code, https://github.com/ernestofgonzalez/epub-utils
Project-URL: Issues, https://github.com/ernestofgonzalez/epub-utils/issues
Project-URL: CI, https://github.com/ernestofgonzalez/epub-utils/actions
Project-URL: Changelog, https://github.com/ernestofgonzalez/epub-utils/releases
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
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: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: lxml
Requires-Dist: pygments
Requires-Dist: PyYAML
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-issues; extra == "docs"
Requires-Dist: furo; extra == "docs"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# epub-utils

[![PyPI](https://img.shields.io/pypi/v/epub-utils.svg)](https://pypi.org/project/epub-utils/)
[![Python 3.x](https://img.shields.io/pypi/pyversions/epub-utils.svg?logo=python&logoColor=white)](https://pypi.org/project/epub-utils/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ernestofgonzalez/epub-utils/blob/main/LICENSE)

A Python CLI and utility library for manipulating EPUB files.

## Features

- Parse and validate EPUB container and package files
- Extract metadata like title, author, and identifier
- Command-line interface for quick file inspection
- Syntax highlighted XML output

## Quick Start

1. Install the package:
```bash
pip install epub-utils
```

2. Use as a CLI tool:
```bash
# Show container.xml contents
epub-utils your-book.epub container

# Show package OPF contents
epub-utils your-book.epub package

# Show table of contents
epub-utils your-book.epub toc
```

3. Use as a Python library:
```python
from epub_utils import Document

# Load an EPUB document
doc = Document("path/to/book.epub")

# Access container metadata
print(f"Package file location: {doc.container.rootfile_path}")

# Access package metadata
print(f"Title: {doc.package.title}")
print(f"Author: {doc.package.author}")
print(f"Identifier: {doc.package.identifier}")
```
