Pamphlet

Pamphlet is a Go library for parsing EPUB files. It extracts metadata, table of contents, and other relevant information from EPUB files.

Features

• Parse EPUB metadata
• Extract table of contents
• Retrieve chapters and manifest items

Installation

To install the library, use go get:

go get github.com/timsims/pamphlet

Usage

Here is an example of how to use the Pamphlet library:

package main

import (
    "fmt"
    "log"
    "github.com/timsims/pamphlet"
)

func main() {
    parser, err := pamphlet.Open("path/to/your.epub")
    if err != nil {
        log.Fatal(err)
    }

    book := parser.GetBook()
    fmt.Printf("Title: %s\n", book.Title)
    fmt.Printf("Author: %s\n", book.Author)
    
    chapters := book.Chapters
    for i, chapter := range chapters {
        fmt.Printf("Chapter %d: %s\n", i+1, chapter.Title)
        fmt.Printf("Content: %s\n", chapter.GetContent())
    }
    
    manifestItems := book.ManifestItems
    for i, item := range manifestItems {
        fmt.Printf("Item Media Type: %s\n", i+1, item.MediaType)
        fmt.Printf("Item %d: %s\n", i+1, item.Href)
    }
}

Open an EPUB file using an os.File object:

    file *os.File
    parser, err := pamphlet.OpenFile(file)
    if err != nil {
        log.Fatal(err)
    }

Open an EPUB file using a byte slice:

    data []byte
    parser, err := pamphlet.OpenBytes(data)
    if err != nil {
        log.Fatal(err)
    }

Testing

To run the tests, use the following command:

go test ./...

Project Structure

• pamphlet.go: Contains the main functions for opening and parsing EPUB files.
• parser.go: Contains the main logic for parsing EPUB files.
• book.go: Contains the Book struct and related functions.
• parser_test.go: Contains tests for the parser.
• epub/: Contains the EPUB-related structs and types.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License.