Skip to content

chunklet.document_chunker.processors.epub_processor

Classes:

  • EpubProcessor –

    Processor class for extracting text and metadata from EPUB files.

EpubProcessor 

EpubProcessor(file_path: str)

Bases: BaseProcessor

Processor class for extracting text and metadata from EPUB files.

Text content is extracted by concatenating the text from all HTML content documents within the EPUB container.

This processor focuses on extracting core metadata following the Dublin Core Metadata Initiative (DCMI) standard, which is the common practice in EPUB files. Not all available metadata fields are extracted.

For more details on EPUB metadata and the Dublin Core standard, refer to the ebooklib tutorial:

https://docs.sourcefabric.org/projects/ebooklib/en/latest/tutorial.html

Initializes the EpubProcessor with a path to the EPUB file and reads the EPUB book into memory.

Parameters:

  • file_path

    (str) –

    Path to the EPUB file.

Methods:

  • extract_metadata –

    Extracts Dublin Core metadata from the EPUB file.

  • extract_text –

    Yields Markdown-converted text from all document items in the EPUB file.

Source code in src/chunklet/document_chunker/processors/epub_processor.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def __init__(self, file_path: str):
    """
    Initializes the EpubProcessor with a path to the EPUB file
    and reads the EPUB book into memory.

    Args:
        file_path (str): Path to the EPUB file.
    """
    if not epub:
        raise ImportError(
            "The 'ebooklib' library is not installed. "
            "Please install it with 'pip install 'ebooklib>=0.19'' or install the document processing extras "
            "with 'pip install 'chunklet-py[document]''"
        )
    self.file_path = file_path
    self.book = epub.read_epub(file_path)

extract_metadata 

extract_metadata() -> dict[str, Any]

Extracts Dublin Core metadata from the EPUB file.

Returns:

  • dict[str, Any] –

    dict[str, Any]: A dictionary containing metadata fields. - title - creator - contributor - publisher - date - rights

Source code in src/chunklet/document_chunker/processors/epub_processor.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def extract_metadata(self) -> dict[str, Any]:
    """
    Extracts Dublin Core metadata from the EPUB file.

    Returns:
        dict[str, Any]: A dictionary containing metadata fields.
            - title
            - creator
            - contributor
            - publisher
            - date
            - rights
    """
    metadata = {"source": str(self.file_path)}
    for field in self.METADATA_FIELDS:
        values = [v[0] for v in self.book.get_metadata("DC", field)]
        if values:
            metadata[field] = ", ".join(values)
    return metadata

extract_text 

extract_text() -> Generator[str, None, None]

Yields Markdown-converted text from all document items in the EPUB file.

Yields:

  • str ( str ) –

    Markdown-formatted text of each document item.

Source code in src/chunklet/document_chunker/processors/epub_processor.py 
76
77
78
79
80
81
82
83
84
85
86
87
def extract_text(self) -> Generator[str, None, None]:
    """
    Yields Markdown-converted text from all document items in the EPUB file.

    Yields:
        str: Markdown-formatted text of each document item.
    """
    for idref, _ in self.book.spine:
        item = self.book.get_item_with_id(idref)
        html_content = item.get_body_content().decode("utf-8", errors="ignore")
        md_content = html_to_md(raw_text=html_content)
        yield md_content.strip()