ebooklib Package

ebooklib Package

epub Module

class ebooklib.epub.EpubBook[source]

Bases: object

add_author(author, file_as=None, role=None, uid='creator')[source]

Add author for this document

add_item(item)[source]
add_metadata(namespace, name, value, others=None)[source]

Add metadata

get_item_with_href(href)[source]
get_item_with_id(uid)[source]
get_items()[source]
get_items_of_media_type(media_type)[source]
get_items_of_type(item_type)[source]
get_metadata(namespace, name)[source]

Retrieve metadata

get_template(name)[source]
reset()[source]

Initialises all needed variables to default values

set_cover(file_name, content, create_page=True)[source]

Set cover and create cover document if needed.

set_identifier(uid)[source]

Sets unique id for this epub

set_language(lang)[source]

Set language for this epub. You can set multiple languages.

set_template(name, value)[source]
set_title(title)[source]

Set title. You can set multiple titles.

class ebooklib.epub.EpubCover(uid='cover-img', file_name='')[source]

Bases: ebooklib.epub.EpubItem

class ebooklib.epub.EpubCoverHtml(uid='cover', file_name='cover.xhtml', image_name='', title='Cover')[source]

Bases: ebooklib.epub.EpubHtml

get_content()[source]
is_chapter()[source]
exception ebooklib.epub.EpubException(code, msg)[source]

Bases: Exception

class ebooklib.epub.EpubHtml(uid=None, file_name='', media_type='', content=None, title='', lang=None)[source]

Bases: ebooklib.epub.EpubItem

add_item(item)[source]
get_body_content()[source]
get_content(default=None)[source]
get_language()[source]
get_type()[source]

Guess type according to the file extension. Not the best way to do it, but works for now.

is_chapter()[source]
set_language(lang)[source]
class ebooklib.epub.EpubImage[source]

Bases: ebooklib.epub.EpubItem

get_type()[source]

Guess type according to the file extension. Not the best way to do it, but works for now.

class ebooklib.epub.EpubItem(uid=None, file_name='', media_type='', content='')[source]

Bases: object

get_content(default='')[source]
get_id()[source]
get_name()[source]
get_type()[source]

Guess type according to the file extension. Not the best way to do it, but works for now.

set_content(content)[source]
class ebooklib.epub.EpubNav(uid='nav', file_name='nav.xhtml', media_type='application/xhtml+xml')[source]

Bases: ebooklib.epub.EpubHtml

is_chapter()[source]
class ebooklib.epub.EpubNcx(uid='ncx', file_name='toc.ncx')[source]

Bases: ebooklib.epub.EpubItem

class ebooklib.epub.EpubReader(epub_file_name, options=None)[source]

Bases: object

DEFAULT_OPTIONS = {}
load()[source]
process()[source]
read_file(name)[source]
class ebooklib.epub.EpubWriter(name, book, options=None)[source]

Bases: object

DEFAULT_OPTIONS = {'epub2_guide': True, 'epub3_landmark': True, 'landmark_title': 'Guide'}
process()[source]
write()[source]

Bases: object

class ebooklib.epub.Section(title)[source]

Bases: object

ebooklib.epub.read_epub(name, options=None)[source]
ebooklib.epub.write_epub(name, book, options=None)[source]

utils Module

ebooklib.utils.debug(obj)[source]
ebooklib.utils.parse_html_string(s)[source]
ebooklib.utils.parse_string(s)[source]