Skip to main content

A Python CLI and utility library for manipulating EPUB files

Project description

epub-utils

PyPI Python 3.x 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:
pip install epub-utils
  1. Use as a CLI tool:
# 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
  1. Use as a Python library:
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}")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epub_utils-0.0.0a3.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

epub_utils-0.0.0a3-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file epub_utils-0.0.0a3.tar.gz.

File metadata

  • Download URL: epub_utils-0.0.0a3.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for epub_utils-0.0.0a3.tar.gz
Algorithm Hash digest
SHA256 7253ee84dedb0bd46c4188bf164f53a928860a907c2b41507fc0e896028724f8
MD5 c6f220ff382fcb4ce6d8bf6f1404edb3
BLAKE2b-256 efcfa537a3a92a1243bea94cf5fe4970c47b70b96f2bf97279790db3ccf772cb

See more details on using hashes here.

File details

Details for the file epub_utils-0.0.0a3-py3-none-any.whl.

File metadata

  • Download URL: epub_utils-0.0.0a3-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for epub_utils-0.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 9bda0f83849797753598ca61bafc7eeb8312a5364c2001bfbc2c4ef3710aee87
MD5 dd38c345ac7b22ca03116432217b5776
BLAKE2b-256 dc69bcddd580be47d3dd0fe2c9da82fcc2ea9119cd84135c244930e4f21e5e7e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page