https://github.com/booktype/ebooklib

Python E-book library for handling books in EPUB2/EPUB3 and Kindle format -
https://github.com/booktype/ebooklib

Last synced: about 1 month ago
JSON representation

Python E-book library for handling books in EPUB2/EPUB3 and Kindle format -

• Host: GitHub
• URL: https://github.com/booktype/ebooklib
• Owner: booktype
• License: agpl-3.0
• Fork: true (aerkalov/ebooklib)
• Created: 2014-04-24T15:46:38.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-06-15T09:55:13.000Z (over 6 years ago)
• Last Synced: 2024-08-01T22:56:11.447Z (4 months ago)
• Language: Python
• Homepage: https://github.com/aerkalov/ebooklib/wiki
• Size: 630 KB
• Stars: 54
• Watchers: 20
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.txt
  • License: LICENSE.txt

Awesome Lists containing this project

• starred-awesome - ebooklib - Python E-book library for handling books in EPUB2/EPUB3 and Kindle format - (Python)

README

        
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=u'
Intro heading
Zaba je skocila u baru.
'


    # add chapter

    book.add_item(c1)

    # 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.

Authors

=======

Full list of authors is in AUTHORS.txt file.