EbookLib.changyy 0.18.2023.1221.0

Ebook library which can handle EPUB2/EPUB3 and Kindle format

about ebooklib.changyy

Please use ebooklib first - https://github.com/aerkalov/ebooklib:

$ pip install ebooklib

---

Here is https://github.com/changyy/ebooklib, used for preliminary testing of ebooklib. All experiments will contribute back to https://github.com/aerkalov/ebooklib.

Current tasks for the project include:

• 2023-12-19 - An extension method for <meta> is added to the EpubHtml object
  • https://github.com/aerkalov/ebooklib/pull/298
• 2023-12-17 - In some HTML elements, attribute names need to be case-sensitive to take effect, for example, the viewBox attribute within the <svg> element.
  • https://github.com/aerkalov/ebooklib/pull/297

---

About EbookLib

EbookLib is a Python library for managing EPUB2/EPUB3 and Kindle files. It's capable of reading and writing EPUB files programmatically (Kindle support is under development).

The API is designed to be as simple as possible, while at the same time making complex things possible too. It has support for covers, table of contents, spine, guide, metadata and etc.

EbookLib is used in Booktype <https://github.com/sourcefabric/Booktype/>_ from Sourcefabric, as well as sprits-it! <https://github.com/the-happy-hippo/sprits-it>, fanfiction2ebook <https://github.com/ltouroumov/fanfiction2ebook>, viserlalune <https://github.com/vjousse/viserlalune>_ and Telemeta <https://github.com/Parisson/Telemeta>_.

Packages of EbookLib for GNU/Linux are available in Debian <https://packages.debian.org/python-ebooklib>_ and Ubuntu <http://packages.ubuntu.com/python-ebooklib>_.

Sphinx documentation is generated from the templates in the docs/ directory and made available at http://ebooklib.readthedocs.io

Usage

Reading

import ebooklib
from ebooklib import epub

book = epub.read_epub('test.epub')

for image in book.get_items_of_type(ebooklib.ITEM_IMAGE):
    print(image)

Writing

from ebooklib import epub

book = epub.EpubBook()

# set metadata
book.set_identifier("id123456")
book.set_title("Sample book")
book.set_language("en")

book.add_author("Author Authorowski")
book.add_author(
    "Danko Bananko",
    file_as="Gospodin Danko Bananko",
    role="ill",
    uid="coauthor",
)

# create chapter
c1 = epub.EpubHtml(title="Intro", file_name="chap_01.xhtml", lang="hr")
c1.content = (
    "<h1>Intro heading</h1>"
    "<p>Zaba je skocila u baru.</p>"
    '<p><img alt="[ebook logo]" src="static/ebooklib.gif"/><br/></p>'
)

# create image from the local image
image_content = open("ebooklib.gif", "rb").read()
img = epub.EpubImage(
    uid="image_1",
    file_name="static/ebooklib.gif",
    media_type="image/gif",
    content=image_content,
)

# add chapter
book.add_item(c1)
# add image
book.add_item(img)

# define Table Of Contents
book.toc = (
    epub.Link("chap_01.xhtml", "Introduction", "intro"),
    (epub.Section("Simple book"), (c1,)),
)

# add default NCX and Nav file
book.add_item(epub.EpubNcx())
book.add_item(epub.EpubNav())

# define CSS style
style = "BODY {color: white;}"
nav_css = epub.EpubItem(
    uid="style_nav",
    file_name="style/nav.css",
    media_type="text/css",
    content=style,
)

# add CSS file
book.add_item(nav_css)

# basic spine
book.spine = ["nav", c1]

# write to the file
epub.write_epub("test.epub", book, {})

License

EbookLib is licensed under the AGPL license <LICENSE.txt>_.

Authors

Full list of authors is in AUTHORS.txt <AUTHORS.txt>_ file.