Python-Epub

Introduction

Connaissez-vous le format de livre numérique appelé “Epub” ? Il s’agit d’un format ouvert, proposé par l’IDPF, qui le présente ainsi :

EPUB is the distribution and interchange format standard for digital publications and documents based on Web Standards. EPUB defines a means of representing, packaging and encoding structured and semantically enhanced Web content — including XHTML, CSS, SVG, images, and other resources — for distribution in a single-file format.

EPUB allows publishers to produce and send a single digital publication file through distribution and offers consumers interoperability between software/hardware for unencrypted reflowable digital books and other publications.

En d’autre terme : c’est un format qui permet de rassembler dans un seul fichier un ensemble de fichiers de type “html&css”, pour publier du contenu - du genre, un livre numérique.

Dans le monde python, si vous cherchez bien, vous trouverez des solutions tout à fait pertinentes d’applications pour lire et éditer des fichiers epub.

Cependant, il s’agit beaucoup de solutions spécifiques (et en outre, très peu de bibliothèques), d’où l’existence de cette bibliothèque qui permet d’ouvrir (en lecture seule pour le moment) des fichiers au format epub (dans la version 2 de la spécification, pour le moment).

Voir aussi : le site l’IDPF et la spécification Epub 2.

Warning

Pour le moment, cette bibliothèque est en phase de développement. Chaque release effectuée sur pypi est testée unitairement (ce qui évite en théorie la présence de bugs), mais l’API n’est pas dans une forme stable. Des changements et évolutions sont notamment à prévoir sur la façon d’accéder aux fichiers contenus dans l’archive epub.

En outre il est vivement déconseillé d’utiliser la version de développement à partir du repository mercurial, ce derniers étant tout sauf stable. Vous êtes par contre vivement encouragés à l’utiliser pour détecter des bugs, proposer des améliorations, et/ou remonter toutes les incohérences et/ou maladresses présentes dans le code.

Les bonnes volontés et les remarques sont toutes bonnes à prendre.

Licence

La licence choisie pour cette bibliothèque est la LGPL.

Installation

Disponible sur pypi, vous pouvez installer Python Epub via la commande “pip” :

pip install epub

Sinon, vous pouvez obtenir la dernière version des sources via mercurial :

hg clone https://bitbucket.org/exirel/epub
cd epub
python setup.py install

Version et compatibilité

Le module epub est disponible en version stable 0.5.0 depuis le 14 Octobre 2012.

Cette version est compatible et testée avec Python 2.7 et Python 3.2.

Cette version est potentiellement compatible avec Python 2.6, mais par manque de tests unitaires le mainteneur du module ne peut pas garantir de compatibilité.

Cette version n’est pas compatible avec des versions de Python antérieures à la version 2.6.

Utilisation

Le cas d’utilisation le plus simple est représenté par le code suivant :

import epub

book = epub.open_epub('path/to/my/book.epub')

for item in book.opf.manifest.values():
    # read the content
    data = book.read_item(item)

Bien entendu, ce n’est qu’un exemple, très incomplet qui plus est, de ce que vous pouvez faire.

Cette bibliothèque ayant pour ambition de suivre les spécifications du format epub, certains éléments pourront paraître obscurs.

Rassurez-vous, cette documentation est là pour vous apporter le plus possible de réponses à vos interrogations.

Table des Matières

Sujet suivant

Le fichier Epub

Cette page